moxygen - Doxygen XML to Markdown converter

  •        108

Moxygen is a Doxygen XML to Markdown converter for C++ developers who want a minimal and beautiful solution for documentating their projects. Moxygen is currently used in conjunction with GitBook to generate the API documentation for LibSourcey.

https://github.com/sourcey/moxygen

Dependencies:

commander : ^2.9.0
handlebars : ^4.0.5
object-assign : ^4.1.0
winston : ^2.2.0
xml2js : ^0.4.16

Tags
Implementation
License
Platform

   




Related Projects

Doxygen Browser Addin for VS

  •    

Doxygen Browser Addin. It's an addin for VS 2005/2008, that allows navigate on Doxygen documentation into the IDE of Visual Studio.

standardese - A (work-in-progress) nextgen Doxygen for C++

  •    C++

Note: The development branch is currently getting a major overhaul, this README is partly out of date and some features are missing. Standardese aims to be a nextgen Doxygen. It consists of two parts: a library and a tool.

DoxBar

  •    C++

DoxBar is an add-in to use doxygen from within Microsoft's Visual C++ IDE. It can be used to run doxygen on a selected project and to search in doxygen generated documentation from within the IDE.

breathe - ReStructuredText and Sphinx bridge to Doxygen

  •    Python

This is an extension to reStructuredText and Sphinx to be able to read and render the Doxygen xml output. The documentation is available here. Thank you to the people running Read the Docs for such an excellent service.

doxygen - Official doxygen git repository

  •    C++

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D. Use the issue tracker to report bugs.


swagger2markup - A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation

  •    Java

The primary goal of this project is to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-ui and can be served as static content. NOTE: The Swagger Specification has been donated to to the Open API Initiative (OAI) and has been renamed to the OpenAPI Specification. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the official swagger-parser and my markup-document-builder.

markdown-mode - Emacs Markdown Mode

  •    Emacs

markdown-mode is a major mode for editing Markdown-formatted text. The latest stable version is markdown-mode 2.3, released on August 31, 2017. See the release notes for details. markdown-mode is free software, licensed under the GNU GPL, version 3 or later. The primary documentation for Markdown Mode is available below, and is generated from comments in the source code. For a more in-depth treatment, the Guide to Markdown Mode for Emacs covers Markdown syntax, advanced movement and editing in Emacs, extensions, configuration examples, tips and tricks, and a survey of other packages that work with Markdown Mode. Finally, Emacs is also a self-documenting editor. This means that the source code itself contains additional documentation: each function has its own docstring available via C-h f (describe-function), individual keybindings can be investigated with C-h k (describe-key), and a complete list of keybindings is available using C-h m (describe-mode).

godocdown - Format package documentation (godoc) as GitHub friendly Markdown

  •    Go

-- Command godocdown generates Go documentation in a GitHub-friendly Markdown format. This program is targeted at providing nice-looking documentation for GitHub. With this in mind, it generates GitHub Flavored Markdown (http://github.github.com/github-flavored-markdown/) by default. This can be changed with the use of the "plain" flag to generate standard Markdown.

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.

markdig - A fast, powerful, CommonMark compliant, extensible Markdown processor for .NET

  •    CSharp

Markdig is a fast, powerful, CommonMark compliant, extensible Markdown processor for .NET.While there is not yet a dedicated documentation, you can find from the specs documentation how to use these extensions.

Doxygen

  •    C++

Doxygen is a JavaDoc like documentation system for C++, C, Java and IDL.

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.

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.

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.

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.

tufao - An asynchronous web framework for C++ built on top of Qt

  •    C++

You can generate documentation from the source code using Doxygen. The documentation will be put on the doc folder in the html and tex formats. There is also experimental support for Qt compressed help files. The library is under the LGPLv2 and public header files, documentation and examples are under MIT license.

ditto - Lightweight Markdown Documentation System

  •    Javascript

ditto inspired by flatdoc is a markdown code documentation system, capable of producing documentation similar to Three.js and Backbone.js, check out live demo here. It is designed for people who use Github Pages to host their code documentation, but you can also host it yourself. Or alternatively see this page for instructions.

academicmarkdown - Academic writing with Markdown

  •    Python

Academic Markdown is a Python module for generating .md, .html, .pdf, .docx, and .odt files from Markdown source. Pandoc is used for most of the heavy lifting, so refer to the Pandoc website for detailed information about writing in Pandoc Markdown. However, Academic Markdown offers some additional functionality that is useful for writing scientific documents, such as integration with Zotero references, and a number of useful Academic Markdown extensions. At present, the main target for Academic Markdown is the OpenSesame documentation site, http://osdoc.cogsci.nl/, although it may in time grow into a more comprehensive and user-friendly tool.

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

FSharp.Formatting - F# tools for generating documentation (Markdown processor and F# code formatter)

  •    F#

The F# Formatting libraries (FSharp.CodeFormat.dll and FSharp.Markdown.dll) include an F# implementation of a Markdown parser and an F# code formatter that can be used to tokenize F# code and obtain information about tokens including tool-tips (as in Visual Studio and MonoDevelop) with type information. The library also comes with a sample that implements literate programming for F#.F# Formatting: Documentation tools provides more information about the library, how to contribute, etc. It also includes links to tutorials showing how to use the Markdown parser and F# code formatter.