https://github.com/skan-io/skan-docs

A example of project docs using docsify, and a tool to automate implementing project docs
https://github.com/skan-io/skan-docs

documentation documentation-generator documentation-tool project-documentation

Last synced: 10 days ago
JSON representation

A example of project docs using docsify, and a tool to automate implementing project docs

• Host: GitHub
• URL: https://github.com/skan-io/skan-docs
• Owner: skan-io
• Created: 2018-05-28T03:45:10.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-14T08:26:55.000Z (over 6 years ago)
• Last Synced: 2024-04-25T08:44:06.725Z (9 months ago)
• Topics: documentation, documentation-generator, documentation-tool, project-documentation
• Language: JavaScript
• Homepage: https://skan-io.github.io/skan-docs/
• Size: 9.27 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## skan-docs

> :books: A project documentation setup tool













## Background

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](https://skan-io.github.io/skan-docs/#/?id=skan-docs) for more details.

## Features

* 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 `github.io` page

* Customizable navbar, sidebar and cover-page

* Smart full-text search plugin

* Emoji support :rocket:

* Compatible with IE10+

## Docsify

> 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](https://docsify.js.org/#/).

## Examples

This repo is built using _skan-docs_.  Check it out [here](/docs).

## Contribute

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](https://github.com/nickmanks/). :heart: