documentationjs / documentationjs/documentation

Markdown only theme

Open
#1,097 1 comment 3 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

I've just finished a documentation.js theme that renders to plain markdown, so I can integrate the output in my documentation generator ([mkdocs](https://www.mkdocs.org/) in this case). Since the default markdown output renders everything in a single file, I hacked my way around the default HTML theme to get it to write the individual sections into markdown files, properly formatted and linked.
This has worked out pretty smooth, you can take a look here: [https://radiergummi.github.io/journeyman](https://radiergummi.github.io/journeyman/api/Command/)

Now my actual question is - would you guys be interested in such a theme? It's kind of a duct tape solution right now but I would certainly be happy to rebuild it properly.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.