All Projects → mattcone → Markdown Guide

mattcone / Markdown Guide

Licence: mit
The comprehensive Markdown reference guide.

Projects that are alternatives of or similar to Markdown Guide

Catalog
Create living style guides using Markdown or React
Stars: ✭ 1,527 (+82.87%)
Mutual labels:  documentation, documentation-tool, markdown
Vuesence Book
Minimalistic Vue.js based documentation system component
Stars: ✭ 48 (-94.25%)
Mutual labels:  documentation, documentation-tool, markdown
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (-65.75%)
Mutual labels:  documentation, documentation-tool, markdown
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (+43.59%)
Mutual labels:  documentation, documentation-tool, markdown
Docsify
🃏 A magical documentation site generator.
Stars: ✭ 19,310 (+2212.57%)
Mutual labels:  documentation, documentation-tool, markdown
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (-47.07%)
Mutual labels:  documentation, markdown
Helm Dash
Browse Dash docsets inside emacs
Stars: ✭ 455 (-45.51%)
Mutual labels:  documentation, documentation-tool
Bluedoc
An open-source document management tool for enterprise self host.
Stars: ✭ 579 (-30.66%)
Mutual labels:  documentation, markdown
Pdoc
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
Stars: ✭ 604 (-27.66%)
Mutual labels:  documentation, documentation-tool
Sphinx
Main repository for the Sphinx documentation builder
Stars: ✭ 4,313 (+416.53%)
Mutual labels:  documentation, documentation-tool
Docbase
Turn .md docs into beautiful sites
Stars: ✭ 595 (-28.74%)
Mutual labels:  documentation-tool, markdown
Documentation
📖 documentation for modern JavaScript
Stars: ✭ 5,443 (+551.86%)
Mutual labels:  documentation, documentation-tool
The Documentation Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+415.69%)
Mutual labels:  documentation, documentation-tool
Mdx Docs
📝 Document and develop React components with MDX and Next.js
Stars: ✭ 412 (-50.66%)
Mutual labels:  documentation, markdown
Ldoc
LDoc is a LuaDoc-compatible documentation generator which can also process C extension source. Markdown may be optionally used to render comments, as well as integrated readme documentation and pretty-printed example files.
Stars: ✭ 481 (-42.4%)
Mutual labels:  documentation, documentation-tool
Assemble
Community
Stars: ✭ 3,995 (+378.44%)
Mutual labels:  documentation, 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 (-27.78%)
Mutual labels:  documentation-tool, markdown
Easybook
Book publishing as easy as it should be (built with Symfony components)
Stars: ✭ 744 (-10.9%)
Mutual labels:  documentation, markdown
Standardese
A (work-in-progress) nextgen Doxygen for C++
Stars: ✭ 713 (-14.61%)
Mutual labels:  documentation, documentation-tool
Zola
A fast static site generator in a single binary with everything built-in. https://www.getzola.org
Stars: ✭ 7,823 (+836.89%)
Mutual labels:  documentation-tool, markdown

Markdown Guide

Build Status

The Markdown Guide is a comprehensive Markdown reference designed for both novices and experts. It was born out of frustration with existing Markdown references that are incomplete and inadequate.

Contributing

Contributions are welcome. Feel free to open a pull request with changes.

Running it Locally

It can be helpful to preview changes on your computer before opening a pull request. The Markdown Guide uses the Jekyll static site generator. After forking or cloning the repository, perform the following steps to generate the site and preview it:

Adding tools

See this page for information about adding applications to the Markdown tools directory.

Deployment

Pull requests merged to the master branch are automatically deployed to the production website.

License

The content of this project itself is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license, and the underlying source code used to format and display that content is licensed under the MIT license.

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].