Skip to content
This repository has been archived by the owner on Sep 7, 2021. It is now read-only.

remko/ampersandjs-dash-generator

Repository files navigation

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.

About

Generate a Dash docset for Ampersand.js

Resources

Stars

Watchers

Forks

Packages

No packages published