fruitjs
FruitJS (pronounced Fruit Juice) is a tool for compiling markdown pages into technical documentation sites.
Last updated 5 years ago by ktsashes .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install fruitjs -g
SYNC missed versions from official npm registry.

#FruitJS

Take a look at our documentation

FruitJS (pronounced Fruit Juice) is a simple yet powerful converter to turn markdown into HTML pages. It was created for the purpose of writing technical documentation and API information in Markdown, and then converting it to a live site. FruitJS is built on Node.js and can be used as an include or as a command line tool.

Getting Started

The simple steps to get started are install it via NPM, then use the command line tool to compile your pages to HTML.

npm install -g fruitjs
fruitjs manifest.json

Manifest File

The manifest file is used to tell the script which pieces should be compiled to HTML. It is a JSON file that should look something like this:

{
	"name"       : "Site Name",
	"pages"      : ["page1.md", "folder/page2.markdown"],
	"css"        : ["styles.css"],
	"less"       : ["otherstyles.less"],
	"js"         : ["Extra JS Code.js"],
	"images"     : ["example1.png", "example2.jpg"],
	"imageTitle" : "path/to/logo.jpg",
	"singlePage" : true,
	"tocLevel"   : 4
}

For more information, read the documentation for the manifest.

##License

FruitJS is under MIT license, and is free to modify, use and distribute within the terms of that license. For full license, check out the LICENSE file.

Current Tags

  • 0.7.0                                ...           latest (5 years ago)

13 Versions

  • 0.7.0                                ...           5 years ago
  • 0.6.4                                ...           6 years ago
  • 0.6.3                                ...           6 years ago
  • 0.6.2                                ...           6 years ago
  • 0.6.1                                ...           6 years ago
  • 0.6.0                                ...           6 years ago
  • 0.5.6                                ...           6 years ago
  • 0.5.5                                ...           6 years ago
  • 0.5.4                                ...           6 years ago
  • 0.5.3                                ...           6 years ago
  • 0.5.2                                ...           6 years ago
  • 0.5.1                                ...           6 years ago
  • 0.5.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 3
Dependencies (6)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |