https://github.com/synw/docdundee

Compose documentation websites for code libraries
https://github.com/synw/docdundee

Last synced: about 2 months ago
JSON representation

Compose documentation websites for code libraries

Host: GitHub
URL: https://github.com/synw/docdundee
Owner: synw
License: mit
Created: 2022-09-18T11:48:26.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-02-13T13:39:06.000Z (4 months ago)
Last Synced: 2025-02-19T12:51:11.312Z (4 months ago)
Language: Vue
Homepage: https://synw.github.io/docdundee/
Size: 95 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 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

:books: Read the documentation

 - [Frontend](https://synw.github.io/docdundee/frontend)

     - [Get started](https://synw.github.io/docdundee/frontend/get_started)

        - [Install](https://synw.github.io/docdundee/frontend/get_started/install)

        - [Overview](https://synw.github.io/docdundee/frontend/get_started/overview)

        - [Configure and run](https://synw.github.io/docdundee/frontend/get_started/configure_and_run)

        - [Markdown](https://synw.github.io/docdundee/frontend/get_started/markdown)

        - [Build](https://synw.github.io/docdundee/frontend/get_started/build)

     - [Interfaces](https://synw.github.io/docdundee/frontend/interfaces)

     - [Navigation](https://synw.github.io/docdundee/frontend/navigation)

        - [The nav tree](https://synw.github.io/docdundee/frontend/navigation/the_nav_tree)

        - [Routing](https://synw.github.io/docdundee/frontend/navigation/routing)

         - [Components](https://synw.github.io/docdundee/frontend/navigation/components)

            - [Auto nav](https://synw.github.io/docdundee/frontend/navigation/components/auto_nav)

            - [Auto nav node](https://synw.github.io/docdundee/frontend/navigation/components/auto_nav_node)

            - [Render nav node](https://synw.github.io/docdundee/frontend/navigation/components/render_nav_node)

            - [Dispatch route](https://synw.github.io/docdundee/frontend/navigation/components/dispatch_route)

         - [Composables](https://synw.github.io/docdundee/frontend/navigation/composables)

            - [Use docloader](https://synw.github.io/docdundee/frontend/navigation/composables/use_docloader)

            - [Use nav](https://synw.github.io/docdundee/frontend/navigation/composables/use_nav)

     - [Renderers](https://synw.github.io/docdundee/frontend/renderers)

        - [Static code block](https://synw.github.io/docdundee/frontend/renderers/static_code_block)

         - [Docstrings](https://synw.github.io/docdundee/frontend/renderers/docstrings)

            - [Render docstring](https://synw.github.io/docdundee/frontend/renderers/docstrings/render_docstring)

         - [Javascript](https://synw.github.io/docdundee/frontend/renderers/javascript)

            - [Js code block](https://synw.github.io/docdundee/frontend/renderers/javascript/js_code_block)

         - [Markdown](https://synw.github.io/docdundee/frontend/renderers/markdown)

            - [Render md](https://synw.github.io/docdundee/frontend/renderers/markdown/render_md)

         - [Python](https://synw.github.io/docdundee/frontend/renderers/python)

            - [Dispatch route py](https://synw.github.io/docdundee/frontend/renderers/python/dispatch_route_py)

            - [Render-py-docstring](https://synw.github.io/docdundee/frontend/renderers/python/render-py-docstring)

            - [Py code block](https://synw.github.io/docdundee/frontend/renderers/python/py_code_block)

         - [Typescript](https://synw.github.io/docdundee/frontend/renderers/typescript)

            - [Ts code block](https://synw.github.io/docdundee/frontend/renderers/typescript/ts_code_block)

 - [Python](https://synw.github.io/docdundee/python)

     - [Api](https://synw.github.io/docdundee/python/api)

     - [Get started](https://synw.github.io/docdundee/python/get_started)

        - [Install](https://synw.github.io/docdundee/python/get_started/install)

        - [Parse docstrings](https://synw.github.io/docdundee/python/get_started/parse_docstrings)

         - [Examples](https://synw.github.io/docdundee/python/get_started/examples)

            - [In docstring](https://synw.github.io/docdundee/python/get_started/examples/in_docstring)

            - [As file](https://synw.github.io/docdundee/python/get_started/examples/as_file)

     - [Types](https://synw.github.io/docdundee/python/types)

 - [Case studies](https://synw.github.io/docdundee/case_studies)

     - [Basics](https://synw.github.io/docdundee/case_studies/basics)

        - [Simple markdown](https://synw.github.io/docdundee/case_studies/basics/simple_markdown)

        - [Python docstrings](https://synw.github.io/docdundee/case_studies/basics/python_docstrings)

### Case studies

- [Simple markdown](https://synw.github.io/docdundee/case_studies/basics/simple_markdown): create a

documentation site with only markdown

- [Python docstrings](https://synw.github.io/docdundee/case_studies/basics/python_docstrings): create a

documentation site from Python docstrings

## Packages

### Javascript

| Version | Name | Description |

| --- | --- | --- |

| [![package](https://img.shields.io/npm/v/@docdundee/docnav)](https://www.npmjs.com/package/@docdundee/docnav) | [@docdundee/docnav](https://www.npmjs.com/package/@docdundee/docnav) | The navigation tree parser |

| [![package](https://img.shields.io/npm/v/@docdundee/nav)](https://www.npmjs.com/package/@docdundee/nav) | [@docdundee/nav](https://www.npmjs.com/package/@docdundee/nav) | The navigation and routing core |

| [![package](https://img.shields.io/npm/v/@docdundee/vue)](https://www.npmjs.com/package/@docdundee/vue) | [@docdundee/vue](https://www.npmjs.com/package/@docdundee/vue) | The Vuejs components |

| [![package](https://img.shields.io/npm/v/@docdundee/tsdoc)](https://www.npmjs.com/package/@docdundee/tsdoc) | [@docdundee/tsdoc](https://www.npmjs.com/package/@docdundee/tsdoc) | The Typescript docstrings parser |

### Python

| Version | Name | Description |

| --- | --- | --- |

| [![pub package](https://img.shields.io/pypi/v/docdundee)](https://pypi.org/project/docdundee/) | [docdundee](https://pypi.org/project/docdundee/) | The Python docstrings parser |

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/synw/docdundee

Awesome Lists containing this project

README