Skip to main content

Display markdown documentation in mara UI

Project description

Mara Markdown Documentation

Display markdown documentation in mara UI

Build Status PyPI - License PyPI version Slack Status

This package displays configured documentation in markdown format in the UI:

  • Convert markdown to html via markdown-it
  • Supports a folder structure (single level) in the menu
  • Supports mermaid diagrams
  • Serves referenced images (.png, .jpg, .gif) in markdown and .txt files (for example config, etc) if these are in the same folder as the markdown file






To use the library directly, use pip:

python3 -m pip install mara-markdown-docs

# or directly from git
python3 -m pip install git+



Assuming you configure via app/

"""Configures the docs functionality"""

import pathlib
from mara_app.monkey_patch import patch

import mara_markdown_docs.config

def documentation() -> dict:
    """Dict with name -> path to markdown file.

    If name contains a single '/' it will be shown in a submenu. Multiple '/' are not allowed.
    The insertion order is mostly preserved (folders are grouped in the menu)."""

    repo_root_dir = pathlib.Path(__file__).parent.parent

    # Cases matter in path!
    docs = {
        'Pipeline/Marketing': repo_root_dir / 'app/pipelines/marketing/',
        'Developer/Setup': repo_root_dir / '',
        'Developer/Code Conventions': repo_root_dir / '',

    return docs

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mara-markdown-docs-0.9.0.tar.gz (6.1 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page