mdoc - node.js markdown powered documentation generator

  •        13

This is a simple markdown based documentation generator, it will search all the markdown files inside the "input" directory and output an HTML file for each document, it will also generate a "TOC" (table of contents) for each file and links to all the pages on the index page, it also provides a basic search feature and quick browsing between classes/methods/properties.Reasoning behind it: inline documentation, why I'm ditching it .

https://github.com/millermedeiros/mdoc.git

Dependencies:

commander : >= 0.4.0
handlebars : >= 1.0.1
showdown : ^1.3.0
wrench : >= 1.3.2

Tags
Implementation
License
Platform

   




Related Projects

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

Dox is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply gives you a JSON representation, allowing you to use markdown and JSDoc-style tags.This output can then be passed to a template for rendering. Look below at the "Properties" section for details.

gutenberg - A fast static site generator in a single binary with everything built-in.

  •    Rust

A fast static site generator in a single binary with everything built-in. Documentation is available on its site or in the docs/content folder of the repository.

zola - A fast static site generator in a single binary with everything built-in.

  •    Rust

A fast static site generator in a single binary with everything built-in. Documentation is available on its site or in the docs/content folder of the repository and the community can use its forum.

vue-styleguidist - Created from react styleguidist for Vue Components with a living style guide

  •    Javascript

Project was started when not finding a tool that generates documentation of components with hot reloading, read documentation and have a playground. Created from React Styleguidist, implement additional support to read and compile .vue files. Only supports 2.x. Vue Styleguidist is a style guide generator for Vue components. It lists component and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server.


dpdk-ovs - Open vSwitch accelerated by Intel® DPDK

  •    C

To get started right away, we recommend that you check out the documentation contained in the [`docs`][docs] directory. These files provide an in-depth overview of the components, system requirements and basic operation of Intel® DPDK vSwitch. The documents are written in Markdown format, so for best results, view the documentation using a Markdown viewer, or on [GitHub][docs].______

docbox - REST API documentation generator

  •    CSS

Docbox is an open source REST API documentation system. It takes structured Markdown files and generates a friendly two-column layout with navigation, permalinks, and examples. The documentation source files that Docbox uses are friendly for documentation authors and free of presentational code: it's Markdown. Docbox is a JavaScript application written with React. The core magic is thanks to the remark Markdown parser, which enables the layout: after parsing a file into an Abstract Syntax Tree, we can move examples to the right, prose to the left, and build the navigation system.

catalog - Create living style guides using Markdown or React

  •    Javascript

Catalog lets you create beautiful living and fully interactive style guides using Markdown and React components. Please read the Catalog documentation (built with Catalog!) for detailed installation and usage instructions.

markdoc - A lightweight Markdown-based wiki system. Current status: abandoned.

  •    Python

Markdoc is a lightweight Markdown-based wiki system. It’s been designed to allow you to create and manage wikis as quickly and easily as possible. Technical Documentation/Manuals Markdoc can be used to write and render hand-written guides and manuals for software. Such documentation will normally be separate from automatically-generated API documentation, and might give a higher-level view than API docs alone. It might be used for client documentation for web/desktop applications, or even developer documentation for frameworks.

spectacle - Beautiful static documentation generator for OpenAPI/Swagger 2.0

  •    HTML

Spectacle generates beautiful static HTML5 documentation from OpenAPI/Swagger 2.0 API specifications. The goal of Spectacle is help you "save time and look good" by providing an extensible platform for auto generating your REST API docs. The default layout is a three column single page, similar to those employed by Stripe and Intercom.

mkdocs - Project documentation with Markdown.

  •    Python

Project documentation with Markdown. Everyone interacting in the MkDocs project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

markdown - A Python implementation of John Gruber’s Markdown with Extension support.

  •    Python

This is a Python implementation of John Gruber's Markdown. It is almost completely compliant with the reference implementation, though there are a few known issues. See Features for information on what exactly is supported and what is not. Additional features are supported by the Available Extensions. Installation and usage documentation is available in the docs/ directory of the distribution and on the project website at https://Python-Markdown.github.io/.

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

JavaScript documentation generator for node using markdown and jsdoc

gray-matter - Smarter yaml front matter parser, used by metalsmith, gatsby, netlify, assemble, mapbox-gl, phenomic, and many others

  •    Javascript

Parse front-matter from a string or file. Fast, reliable and easy to use. Parses YAML front matter by default, but also has support for YAML, JSON, TOML or Coffee Front-Matter, with options to set custom delimiters. Used by metalsmith, assemble, verb and many other projects. Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

react-styleguidist - Isolated React component development environment with a living style guide

  •    Javascript

React Styleguidist is a component development environment with hot reloaded dev server and a living style guide that you can share with your team. It lists component propTypes and shows live, editable usage examples based on Markdown files. Check out the demo style guide. The change log can be found on the Releases page.

liferay-docs

  •    CSS

Welcome to Liferay's official documentation project, the home of Liferay Developer Network articles. All articles are written in Markdown, making them easy to write and read. Approved articles are uploaded to the Liferay Developer Network (LDN) and converted automatically to HTML. In this project, you can contribute new articles, improve existing articles, or fix documentation bugs. To produce documentation that is comprehensive and stylistically consistent, the liferay-docs project provides writing guidelines, standards & customizations, and a tutorial template.You'll learn how quickly to submit a new article and its images next.

protoc-gen-doc - Documentation generator plugin for Google Protocol Buffers

  •    Go

This is a documentation generator plugin for the Google Protocol Buffers compiler (protoc). The plugin can generate HTML, JSON, DocBook and Markdown documentation from comments in your .proto files. It supports proto2 and proto3, and can handle having both in the same context (see examples for proof).

Sphinx - Python Documentation Generator

  •    Python

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python. It also supports C and C++. The support for other languages is in the plan. Support for multiple output formats are supported.