jaredly / jaredly/redoc

Generating MD files for Docusaurus

Open
#22 0 comments 4 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
114
Forks
11
PR merge metrics
No merged PRs in 30d

Description

This is definitely more of a question than a bug report (or even feature request)...

I'm hoping to end up with [Docusaurus](https://docusaurus.io/en/) docs for a library I'm working on. I'd like these docs to be a mix of hand-written "guide" pages and API docs generated from docblock comments in my code.

`redoc`'s ability to make sense of both docblock comments and `rei`/`mli` interface files seems incredibly promising, but it generates a full HTML site, while Docusaurus expects to find Markdown pages. How suitable is `redoc` for this task, and where would you recommend I start digging in if I want to modify it for this use case?

Thanks for building this sweet tool!

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue asks whether redoc can support Docusaurus Markdown pages instead of generating a full HTML site. Start by investigating redoc's output generation and Docusaurus's Markdown requirements; done would be a documented feasibility answer or an agreed implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.