All Projects → appbaseio → Docbase

appbaseio / Docbase

Licence: mit
Turn .md docs into beautiful sites

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Docbase

Markdown Guide
The comprehensive Markdown reference guide.
Stars: ✭ 835 (+40.34%)
Mutual labels:  documentation-tool, markdown
Ascidia
A command-line utility for rendering technical diagrams from ASCII art
Stars: ✭ 80 (-86.55%)
Mutual labels:  documentation-tool, markdown
Tbls
tbls is a CI-Friendly tool for document a database, written in Go.
Stars: ✭ 940 (+57.98%)
Mutual labels:  documentation-tool, markdown
Boostnote.next
Boost Note is a powerful, lightspeed collaborative workspace for developer teams. Forum (New!): https://github.com/BoostIO/BoostNote-App/discussions
Stars: ✭ 2,682 (+350.76%)
Mutual labels:  markdown, documentation-tool
Pydoc Markdown
Create Python API documentation in Markdown format.
Stars: ✭ 273 (-54.12%)
Mutual labels:  documentation-tool, markdown
Zola
A fast static site generator in a single binary with everything built-in. https://www.getzola.org
Stars: ✭ 7,823 (+1214.79%)
Mutual labels:  documentation-tool, markdown
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (+101.51%)
Mutual labels:  documentation-tool, markdown
Daux.io
Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
Stars: ✭ 603 (+1.34%)
Mutual labels:  documentation-tool, markdown
Catalog
Create living style guides using Markdown or React
Stars: ✭ 1,527 (+156.64%)
Mutual labels:  documentation-tool, markdown
Balsa
This repository holds source code of Balsa, a self hosted, privacy focused knowledgebase.
Stars: ✭ 93 (-84.37%)
Mutual labels:  documentation-tool, markdown
Vuesence Book
Minimalistic Vue.js based documentation system component
Stars: ✭ 48 (-91.93%)
Mutual labels:  documentation-tool, markdown
Plato
Plato helps software teams connect & stay engaged with users to gather feedback, provide support & deliver better software.
Stars: ✭ 293 (-50.76%)
Mutual labels:  documentation-tool, markdown
Ignite
Modern markdown documentation generator
Stars: ✭ 83 (-86.05%)
Mutual labels:  documentation-tool, markdown
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (-51.93%)
Mutual labels:  documentation-tool, markdown
Docsify
🃏 A magical documentation site generator.
Stars: ✭ 19,310 (+3145.38%)
Mutual labels:  documentation-tool, markdown
Ml Note
📙慢慢整理所学的机器学习算法,并根据自己所理解的样子叙述出来。(注重数学推导)
Stars: ✭ 537 (-9.75%)
Mutual labels:  markdown
Remarkable
Markdown parser, done right. Commonmark support, extensions, syntax plugins, high speed - all in one. Gulp and metalsmith plugins available. Used by Facebook, Docusaurus and many others! Use https://github.com/breakdance/breakdance for HTML-to-markdown conversion. Use https://github.com/jonschlinkert/markdown-toc to generate a table of contents.
Stars: ✭ 5,252 (+782.69%)
Mutual labels:  markdown
Notes Up
Markdown notes editor & manager
Stars: ✭ 535 (-10.08%)
Mutual labels:  markdown
Zettlr
A Markdown Editor for the 21st century.
Stars: ✭ 6,099 (+925.04%)
Mutual labels:  markdown
Kodexplorer
A web based file manager,web IDE / browser based code editor
Stars: ✭ 5,490 (+822.69%)
Mutual labels:  markdown

Docbase

Build Status NPM

We are no longer actively maintaining Docbase, we instead recommend using gatsbyjs.

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.

A rendered documentation site

Example Hubs built with Docbase

  1. Airbnb JS Style guide
  2. Redis Docs
  3. EmberJS Guide

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

The manual walks through the generator options, and explains docbase options and features. The manual itself is served with docbase.

Who uses docbase

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

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].