Generate a Dash docset for Ampersand.js
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
vendor
.eslintignore
.eslintrc
.gitignore
.gitmodules
.travis.yml
Info.plist.mustache
README.md
amp.jade
amp.js
ampersand-guides.js
ampersand-modules.js
build.js
docset.json.mustache
dummy.js
entries.js
feed.jade
feed.xml.mustache
guide.jade
icon.png
icon@2x.png
index.jade
module.jade
package.json
style.css

README.md

ampersandjs-dash-generator: Generate a Dash docset for Ampersand.js

Generates a Dash docset of all Ampersand.js modules.

If you are just interested in installing the docset (and not in building it yourself), just click here to install the docset. This docset is bundled as a user contribution with Dash, which is updated regularly, but the link above will always get you the latest version.

Installation

To install the prerequisites, run

	git submodule update --init
	npm install

Usage

To build the docset, run

	npm run build

This will create a build directory with all build results.

Use the resulting docset by adding the .docset to the Docsets tab of Dash.

The build command also generates a Dash feed in feed. The .html file in the feed dir contains the Dash URL, which will install the docset when it is opened.