Turn markdown files into a beautiful documentation hub.
Getting up and running takes only 5 minutes
1. npm install -g yo
█████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
2. npm install -g generator-docbase
██████████▒▒▒▒▒▒▒▒▒▒
3. yo docbase
Welcome to
.___ ___.
__| _/____ ____\_ |__ _____ ______ ____
/ __ |/ _ \_/ ___\| __ \\__ \ / ___// __ \
/ /_/ ( <_> ) \___| \_\ \/ __ \_\___ \\ ___/
\____ |\____/ \___ >___ (____ /____ >\___ >
\/ \/ \/ \/ \/ \/
generator!
...
████████████████████
Docbase is live at: http://127.0.0.1:1234
A github first workflow
Docbase is designed to work well with your github workflow. It can:
- read markdown projects from a github repository.
- deploy docbase to gh-pages.
- provide github enabled editing.
- integrate with travis-ci for continuous deployment.
Built-in realtime search
Docbase generates an offline search index for the docs. When published, it creates a beautiful search bar with realtime (
) auto completion and
highlighting support.
It's colorful
Docs should look beautiful. Docbase is designed with customization in mind so it can adapt to your theme colors.
Just yo docbase and provide a valid css color for your theme (like green, rgb(100,150,200), #ffb14c)
Just yo docbase and provide a valid css color for your theme (like green, rgb(100,150,200), #ffb14c)
Works at all sizes
Some popular markdown documentation websites served with docbase.
EmberJS Guide
EmberJS is a popular Javascript MVC framework. Their docs are written in markdown and organized in a structure that can be supported by Docbase. Check them below.
Redis Docs
Redis is one of the most popular datastructure database out there. With 250+ commands and numerous topics, we thought Redis.io's docs are ideal to test docbase's limits.