Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK][MEDIUM] Unlock advanced features of markdown in docs #6254

Open
3 tasks done
pan3793 opened this issue Apr 3, 2024 · 0 comments
Open
3 tasks done

[TASK][MEDIUM] Unlock advanced features of markdown in docs #6254

pan3793 opened this issue Apr 3, 2024 · 0 comments

Comments

@pan3793
Copy link
Member

pan3793 commented Apr 3, 2024

What's the level of this task?

MEDIUM

Code of Conduct

Search before creating

  • I have searched in the task list and found no similar tasks.

Mentor

  • I have sufficient expertise on this task, and I volunteer to be a mentor of this task to guide contributors through the task.

Skill requirements

  • Sphinx, and maybe some HTML and CSS skills

Background and Goals

Kyuubi uses Sphinx to build the docs, and RST and Markdown are mixed-used.

RST is a much more powerful format but easy to mess up and hard to learn, while Markdown is more popular and easy to learn.

Currently, Kyuubi uses a legacy markdown==3.4.1 for Sphinx markdown support, which lacks some advanced features, e.g. variable substitution, which is likely to be used for "version"

While the recommended powerful markdown solution is myst_parser https://www.sphinx-doc.org/en/master/usage/markdown.html, we should investigate and migrate to this one.

Implementation steps

Additional context

Introduction of 2024H1 Kyuubi Code Contribution Program

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant