Skip to content

Latest commit

 

History

History
99 lines (61 loc) · 3.25 KB

README.md

File metadata and controls

99 lines (61 loc) · 3.25 KB
Raw

fastdocs

Automatically generated Docsify flavored documentation sites for your markdown files! We are a README-as-a-Service project, spin up beautiful versions of your documentation in seconds! And the best part? We are completely free and open-source!

Getting Started

To render your docs all you have to do is go to /:user/:repo/ thats it! Currently, fastdocs only supports GitHub.

?> :user should be replaced with your GitHub username

?> :repo should be replaced with the name of the GitHub repository

We automatically compile it with docsify and serve it at /docs/:user/:repo/.

!> Make sure you ALWAYS go to /:user/:repo and not /docs/:user/:repo, the /docs/ endpoint will not be available 24x7 due to hosting, but /:user/:repo always will be. Although we don't have an ETA, we are working on fixing this issue.

Example:

To render documentation from https://github.com/cheeriojs/cheerio, where the :user is cheeriojs and :repo is cheerio you can simply go to https://fastdocs.io/cheeriojs/cheerio to view the rendered documentation!

Configuration

To add a description for SEO purposes, or to add plugins to your documentation, you need to create a .fastdocs.json file in the root of your repo.

Example repo file structure :

├── .fastdocs.json
├── build/
├── src/
└── README.md

Config Schema

Once you have made the .fastdocs.json file, the currently supported options are:

{
  "description": "Description",
  "plugins": [],
  "gaCode": ""
}

description

The description of your project. Mainly for SEO purposes when docs are linked on platforms like facebook, twitter, linkedin, etc.

  • type: string
  • default: "Description"
  • example usage: "App that sends hello world every 2 seconds"

plugins

List of plugins you would like added to your docs. Supported plugins right now:

full-text-search

Adds a search bar on the top of the sidebar to quickly search docs.

docsify-copy-code

Adds a "Copy to Clipboard" next to code blocks.

google-analytics

Support for google analytics. Pass in the google analytics code to gaCode

emoji

Renders emoji's in your documentation. (Ex: :100: would render to 💯)

zoom-image

Adds subtle zooming to images cursor is hovering.

  • type: string array
  • default: [""]
  • example usage: ["docsify-copy-code", "full-text-search"]

gaCode

Pass in your google analytics code if you have specified google-analytics in the plugins array. This field is optional and can be ignored if it does not apply to you.

  • type: string
  • default: ""
  • example usage: "UA-GXXXY"

Contribution

Everyone is encouraged to contribute to this project, there are no restrictions other than following the semantic-commit conventions. If you want to contribute by reporting bugs, or suggesting new features you are welcome to do so on our Issue Tracker