Support for mermaid
Open
Nobody has claimed this yet.
feature-request
type/enhancement
website
- Dominant language
- Python
- Stars
- 617
- Forks
- 724
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 223
Description
@qiancai we can't use mermaid for docs like on github, right?
We can't, because the current tool for generating PDFs from docs doesn't support Mermaid.
Originally posted by @Yuiham in https://github.com/pingcap/docs/issues/5783#issuecomment-1831325879
PDF Generation:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with scripts/generate_pdf.sh and scripts/generate_cloud_pdf.sh, then inspect the current PDF-generation tool's Mermaid support. Done means Mermaid diagrams render successfully in PDFs generated through both paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100