Docdundee

Compose documentation websites in Vuejs. Features:

• Markdown render markdown documents with code syntax highlighting
• Docstrings: parse python docstrings and generate api doc
• Interactive executable examples for Python, Typescript and Javascript

Documentation

📚 Read the documentation

• Frontend
  • Get started
    • Install
    • Overview
    • Configure and run
    • Markdown
    • Build
  • Interfaces
  • Navigation
    • The nav tree
    • Routing
    • Components
      • Auto nav
      • Auto nav node
      • Render nav node
      • Dispatch route
    • Composables
      • Use docloader
      • Use nav
  • Renderers
    • Static code block
    • Docstrings
      • Render docstring
    • Javascript
      • Js code block
    • Markdown
      • Render md
    • Python
      • Dispatch route py
      • Render-py-docstring
      • Py code block
    • Typescript
      • Ts code block
• Python
  • Api
  • Get started
    • Install
    • Parse docstrings
    • Examples
      • In docstring
      • As file
  • Types
• Case studies
  • Basics
    • Simple markdown
    • Python docstrings

Case studies

• Simple markdown: create a documentation site with only markdown
• Python docstrings: create a documentation site from Python docstrings

Packages

Javascript

Version	Name	Description
	@docdundee/docnav	The navigation tree parser
	@docdundee/nav	The navigation and routing core
	@docdundee/vue	The Vuejs components
	@docdundee/tsdoc	The Typescript docstrings parser

Python

Version	Name	Description
	docdundee	The Python docstrings parser