Skip to content

Web frameworks

Static site generators

Comparison of static site generators: https://www.staticgen.com/.

Go

Hugo

JavaScript

[GitBook]

  • Need to include every markdown file that you want rendered inside the SUMMARY.md file (ok, just need to write a script to do this...).

[Gatsby]

Python

MkDocs

  • Does not support relative links to images using \<img> tags (problem with '..' offset, see mkdocs/mkdocs#991).
  • Themes:

Sphinx

  • Does not support relative links to images using \<img> tags (images get moved to a separate images).
  • Themes:

sphinx.ext.autosummary example:

submodule/__init__.py:

"""
Submodule
=========

hello world
"""

class SomeOther(object):
    """Some other class"""

    #: First class attribute
    x: str

    #: Second class attribute
    y: str

#: This is attribute of submodule, of type boolean
ATTRIBUTE_OF_SUBMODULE = True

OTHER_ATTRIBUTE_OF_SUBMODULE = SomeOther()
"""This is *other* attribute of type :class:`SomeClass`"""

docs/conf.py:

.. automodule:: submodule

.. autosummary::

    ATTRIBUTE_OF_SUBMODULE
    OTHER_ATTRIBUTE_OF_SUBMODULE
    SomeOther

.. autoclass:: SomeOther
    :members:

Math

  • https://github.com/cben/mathdown/wiki/math-in-markdown

recommonmark has the same math formula syntax as GitLab flavoured markdown.

Sphinx

Themes

Extensions

  • nbsphinx

Jupyter

Templates

Presentation frameworks

  • decktape - Save common javascript presentation types to PDF using qt webkit. The README file contains a list of good javascript slide frameworks that are supported.
  • revealjs - The HTML Presentation Framework.
  • spectacle - Another presentation framework, based on react. More actively developed than revealjs.

Flowchart diagrams

  • sketchviz — Hand-drawn theme for graph-viz.
  • mermaid — Generation of diagram and flowchart from text in a similar manner as markdown

http://knsv.github.io/mermaid/

flowchart.js

Draws simple SVG flow chart diagrams from textual representation of the diagram http://flowchart.js.org/

js-sequence-diagrams

Draws simple SVG sequence diagrams from textual representation of the diagram https://bramp.github.io/js-sequence-diagrams/

Wiki engines

Python

django-wiki

A wiki system with complex functionality for simple integration and a superb interface. Store your knowledge with style Use django models. https://demo.django.wiki

realms-wiki

Git based wiki inspired by Gollum http://realms.io

waliki

A wiki engine powered by Django and Git http://waliki.pythonanywhere.com

MoinMoin

Still alpha but many great features planned (including Markdown and ReST support)

XWIKI

The most popular Java framework. Used by PhenoTips. Taylored towards the enterprise folk.