sphinxcontrib-mermaid - Mermaid diagrams in yours sphinx powered docs

  •        492

This extension allows you to embed Mermaid graphs in your documents, including general flowcharts, sequence and gantt diagrams. By default, the HTML builder will simply render this as a div tag with class="mermaid", injecting the external javascript, css and initialization code to make mermaid works.

http://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/
https://github.com/mgaitan/sphinxcontrib-mermaid

Tags
Implementation
License
Platform

   




Related Projects

MyST-Parser - An extended commonmark compliant parser, with bridges to docutils/sphinx

  •    Python

MyST is a rich and extensible flavor of Markdown meant for technical documentation and publishing. MyST is a flavor of markdown that is designed for simplicity, flexibility, and extensibility. This repository serves as the reference implementation of MyST Markdown, as well as a collection of tools to support working with MyST in Python and Sphinx. It contains an extended CommonMark-compliant parser using markdown-it-py, as well as a Sphinx extension that allows you to write MyST Markdown in Sphinx.

Mermaid - Generation of diagram and flowchart from text in a similar manner as markdown

  •    Javascript

Mermaid is a Javascript based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development. Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning.

mermaid-live-editor - Edit, preview and share mermaid charts/diagrams

  •    Svelte

If you want to speed up the progress for mermaid-live-editor, join the slack channel and contact knsv. Edit, preview and share mermaid charts/diagrams.

readthedocs.org - The source code that powers readthedocs.org

  •    Python

Read the Docs hosts documentation for the open source community. It supports Sphinx docs written with reStructuredText, and can pull from your Subversion, Bazaar, Git, and Mercurial repositories. Then we build documentation and host it for you. Think of it as Continuous Documentation. You will find complete documentation for setting up your project at the Read the Docs site.

hieroglyph - Generate HTML presentations from plain text sources with all the power of Sphinx.

  •    Javascript

Hieroglyph is an extension for Sphinx which builds HTML presentations from ReStructured Text documents. Hieroglyph supports Sphinx 1.4 and later, and Python 2.7 and 3.6.


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.

readthedocs.org - The source code that powers readthedocs.org

  •    Python

Read the Docs hosts documentation for the open source community. It supports Sphinx docs written with reStructuredText, and can pull from your Subversion, Bazaar, Git, and Mercurial repositories. Then we build documentation and host it for you. Think of it as Continuous Documentation. You will find complete documentation for setting up your project at the Read the Docs site.

esphome-docs - Source for esphome.io documentation files.

  •    Python

For issues, please go to the issue tracker. For feature requests, please see feature requests.

alabaster - Lightweight, configurable Sphinx theme. Now the Sphinx default!

  •    Python

Alabaster is a visually (c)lean, responsive, configurable theme for the Sphinx documentation system. It is Python 2+3 compatible. It began as a third-party theme, and is still maintained separately, but as of Sphinx 1.3, Alabaster is an install-time dependency of Sphinx and is selected as the default theme.

thinking-sphinx - Sphinx plugin for ActiveRecord/Rails

  •    Ruby

Thinking Sphinx is a library for connecting ActiveRecord to the Sphinx full-text search tool, and integrates closely with Rails (but also works with other Ruby web frameworks). The current release is v4.0.0. Please refer to the changelog and release notes for any changes you need to make when upgrading. The release notes in particular are quite good at covering breaking changes and more details for new features.

sphinx - Main repository for the Sphinx documentation builder

  •    Python

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

UMLGraph - Automated Drawing of UML Diagrams

  •    Java

UMLGraph allows the declarative specification and drawing of UML class and sequence diagrams. The current features are part of an ongoing effort aiming to provide support for all types UML diagrams. Running the UmlGraph doclet on the specification will generate a Graphviz diagram specification that can be automatically processed to create Postscript, GIF, SVG, JPEG, fig, or Framemaker drawings.

sphinxbase

  •    C

This package contains the basic libraries shared by the CMU Sphinx trainer and all the Sphinx decoders (Sphinx-II, Sphinx-III, and PocketSphinx), as well as some common utilities for manipulating acoustic feature and audio files. Please see the LICENSE file for terms of use.

sphinx-autoapi - A new approach to API documentation in Sphinx.

  •    Python

Sphinx AutoAPI provides "autodoc" style documentation for multiple programming languages without needing to load, run, or import the project being documented. In contrast to the traditional Sphinx autodoc, which is Python-only and uses code imports, AutoAPI finds and generates documentation by parsing source code.

Dia - Visio alternative

  •    GTK+

Dia is inspired by the commercial Windows program Visio, though more geared towards informal diagrams for casual use. It can be used to draw many different kinds of diagrams. It currently has special objects to help draw entity relationship diagrams, UML diagrams, flowcharts, network diagrams, and many other diagrams. It is also possible to add support for new shapes by writing simple XML files, using a subset of SVG to draw the shape.

django-sphinx - A transparent layer for full-text search using Sphinx and Django

  •    Python

A transparent layer for full-text search using Sphinx and Django

sphinx-bootstrap-theme - Sphinx Bootstrap Theme

  •    Javascript

Sphinx Bootstrap Theme

C++ Sphinx client library

  •    C++

Sphinx searchserver C++ client library, an alternative to the native C library distributed with sphinx. The communication module is written using unix sockets, so this library is only suitable for unix-like systems.

.NET Sphinx Client

  •    

A .NET client for the Sphinx search engine (http://sphinxsearch.com/) written in C#

Sphinx Client

  •    

.Net Sphinx Search Engine protocol client made in .Net, Sphinx is an open source database search engine, http://www.sphinxsearch.com






We have large collection of open source products. Follow the tags from Tag Cloud >>


Open source products are scattered around the web. Please provide information about the open source projects you own / you use. Add Projects.