OpenAPITools / OpenAPITools/openapi-generator

[REQ] Docusaurus Markdown support

Open
#9,410 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Docusaurus is a well-known static site generator. (It is used by https://openapi-generator.tech as well.)

We tried to place the markdown files generated by markdown generator directly under Docusaurus, and find that there is extra work before the markdown files well parsed by Docusaurus.

Describe the solution you'd like

According to https://docusaurus.io/docs/create-doc, following header is required for each markdown file:

---
id: greeting
title: Hello
---

It'd be nice to add a logic to include this header in the markdown generator.

Another change that's needed is described as a bug in https://github.com/OpenAPITools/openapi-generator/issues/9407

Describe alternatives you've considered

Not really, other than manually update each markdown file.

Additional context

This rendered page below is based on a hand curated markdown file generated by markdown generator. We can see it's still imperfect.

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the markdown generator and review issue #9407 for the related parsing problem. The change is done when generated Markdown files include Docusaurus-compatible front matter with the required id and title fields; the payload names no specific source file or test.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.