Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appbaseio/Docbase
Turn .md docs into beautiful sites
https://github.com/appbaseio/Docbase
appbaseio docbase documentation-hub documentation-tool javascript markdown
Last synced: 6 days ago
JSON representation
Turn .md docs into beautiful sites
- Host: GitHub
- URL: https://github.com/appbaseio/Docbase
- Owner: appbaseio
- License: mit
- Archived: true
- Created: 2015-02-09T17:16:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-01T06:03:47.000Z (almost 7 years ago)
- Last Synced: 2024-09-28T19:03:40.241Z (about 1 month ago)
- Topics: appbaseio, docbase, documentation-hub, documentation-tool, javascript, markdown
- Language: JavaScript
- Homepage: https://appbaseio.github.io/Docbase
- Size: 7.26 MB
- Stars: 590
- Watchers: 19
- Forks: 24
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - Docbase - Turn .md docs into beautiful sites (JavaScript)
README
# Docbase
[](https://travis-ci.org/appbaseio/Docbase) [](https://nodei.co/npm/grunt-docbase/)
### We are no longer actively maintaining Docbase, we instead recommend using [gatsbyjs](https://gatsbyjs.org).
Turn .md files into a beautiful documentation hub with versioning and beautifully rendered menus.
* Docbase can read files that are hosted on github, locally or a http:// server.
* It can publish documentation hubs to github pages (via travis) or locally which can be served with as static files with a http:// server.
Docbase comes with a yeoman generator that turns the installation and configuration process into a piece of cake.
### Example Hubs built with Docbase
1. [Airbnb JS Style guide](https://farhan687.github.io/airbnb)
2. [Redis Docs](https://farhan687.github.io/redis)
3. [EmberJS Guide](https://farhan687.github.io/emberjs)
## Installation
```
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
```
## [Read the manual](https://appbaseio.github.io/docbase-manual) [](https://appbaseio.github.io/docbase-manual)
The manual walks through the generator options, and explains docbase options and features. The manual itself is served with docbase.
### Who uses docbase
- [appbase.io](https://docs.appbase.io)
- [Reactive Maps](https://opensource.appbase.io/reactivemaps/manual)
Send a PR with your name here.
## History
v0.3.0 Feb 27 '17
- Phantom.js dependency upgrade
- Compatibility with Node v6.9.x
- Uses scroll in code blocks
- Fixes mobile read view
- Adds a feature to see other pages in the directory
v0.2.56 Apr 2 '16
- Comes with a yeoman generator ``yo docbase``
- Resizable mobile navigation menu
- Realtime search with an offline search index
- No 404s when navigating to folders
- Updates markdown parser
- Show github contributors on each documentation page
- Colorful themes baked in
.
. (54 more releases)
.
v0.0.2 Aug 7 '15
- All flatdoc theme options supported
- Customizable root path
v0.0.1 Feb 10 '15
- Initial release
## Credits
Henrique Sa (@henriquesa),
Mateus Freira (@mateusfreira),
Farhan Chauhan (@farhan687),
Siddharth Kothari (@siddharthlatest)
## License
MIT