A example of project docs using docsify, and a tool to automate implementing project docs.
Last updated a year ago by skan-admin .
UNLICENSED · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install skan-docs 
SYNC missed versions from official npm registry.


:books: A project documentation setup tool

Build Status contributions welcome Coverage Status code style: prettier


The skan-docs CLI tool can automate the documentation setup process for your project. Running skan-docs will download and install docsify-cli, skan-convert, serve, remark-lint, remark-cli, jsdoc, jsdoc plugins, react-styleguidist and npm-run-all via npm. It will also copy a set of template files into your docs/ directory and add the docs and lint commands to your package.json so that you can quickly get your project documentation up and running.

See the Quick start for more details.


  • Simple command line tool
  • Modern theme
  • JSDoc integration for code docs
  • React component style guide
  • Write your docs in markdown syntax
  • Scripts automatically added to package.json
  • Easily install and push to your page
  • Customizable navbar, sidebar and cover-page
  • Smart full-text search plugin
  • Emoji support :rocket:
  • Compatible with IE10+


This project is built upon docsify. For more information on the project or if you want to extend its functionality have a look at their documentation.


This repo is built using skan-docs. Check it out here.


Please consider donating your time if you think skan-docs is helpful to you or that my work is valuable. Or let's get a cup of coffee. :heart:

Current Tags

  • 1.1.0                                ...           latest (a year ago)

11 Versions

  • 1.1.0                                ...           a year ago
  • 1.0.9                                ...           a year ago
  • 1.0.8                                ...           a year ago
  • 1.0.7                                ...           a year ago
  • 1.0.6                                ...           a year ago
  • 1.0.5                                ...           a year ago
  • 1.0.4                                ...           a year ago
  • 1.0.3                                ...           a year ago
  • 1.0.2                                ...           a year ago
  • 1.0.1                                ...           a year ago
  • 1.0.0                                ...           a year ago
Maintainers (1)
Today 0
This Week 0
This Month 4
Last Day 0
Last Week 2
Last Month 2
Dependencies (15)
Dev Dependencies (0)
Dependents (0)

Copyright 2014 - 2016 © |