node-slate as a gulp task
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
.travis.yml
LICENSE.txt
README.md
index.js
package.json
spec-runner.sh.command
spec.js

README.md

logo
Slate helps you create beautiful, intelligent, responsive API documentation.
screenshot

gulp-node-slate

node-slate as a gulp task

npm   dependencies Status   Known Vulnerabilities   Build Status

A) Lightning quick demo

Don't have an existing gulp project? Just want to experiment with no commitment?

Blindly enter these commands:

$ mkdir my-api-docs
$ cd my-api-docs
$ npm init --yes
$ npm install gulp@4 --save-dev
$ npm install gulp-node-slate --save-dev
$ cat > gulpfile.js << EOF
const gulp =  require('gulp');
const slate = require('gulp-node-slate');
function generateApiDocs() { return gulp.src('.').pipe(slate()); }
gulp.task('slate', generateApiDocs);
EOF
$ node node_modules/gulp/bin/gulp.js slate
$ open build/index.html

Otherwise, follow the steps below.

B) Instructions

1. Install into your project:

$ npm install gulp-node-slate --save-dev

2. Add a task to your gulpfile.js:

const slate = require('gulp-node-slate');
function generateApiDocs() { return gulp.src([]).pipe(slate()); }
gulp.task('slate', generateApiDocs);

3. Build and view the API documentation:

$ gulp slate
$ ls source
$ open build/index.html

The structure of the generated source folder is:

source/
   images/
      logo.png
   includes/
      *.md
   custom.scss
   index.yml

4. Get to work

Customize the files in the source folder to create your API documentation and then rerun gulp slate.

C) Configuration

Example of passing in options:

.pipe(slate({ source: 'api-docs/input', build: 'api-docs/output' }))

Options:

  • source – Relative path to the Slate API documentation input folder (default: 'source').
  • build – Relative path to the Slate API documentation output folder (default: 'build').

E) Notes

  1. If you want to contribute to the project, fork it and then run the spec-runner.sh.command script and examine the contents of the api-docs folder. Pull requests are welcome.
  2. If you have a question, suggestion, or bug to report, open an issue.

MIT License