Skip to content

Commit

Permalink
docs: updated documentation for no compile endpoint (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
aemmadi committed Aug 21, 2020
1 parent 3c27056 commit 89a6e1a
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,9 @@ Automatically generated [Docsify](https://docsify.js.org/#/) flavored documentat

# Getting Started

## Compile your docs
To render your docs all you have to do is go to `/:user/:repo/` thats it! We automatically compile it with docsify and serve it at `/docs/:user/:repo/`.

To add your repo documentation to FastDocs, you would need to visit `/:user/:repo/compile` first. This allows us to store your `README.md` and add [Docsify](https://docsify.js.org/#/) to render it.

You need to visit this compile endpoint everytime you would like your fastdocs to be updated.

## View your docs

Once you have compiled your docs, you can view and share the pretty version of your docs at `/:user/:repo/`!

That's it, it's that simple and fast!
!> 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.

# Configuration

Expand Down

0 comments on commit 89a6e1a

Please sign in to comment.