diff --git a/next/README b/next/README.md similarity index 89% rename from next/README rename to next/README.md index 5c78a33a..61010093 100644 --- a/next/README +++ b/next/README.md @@ -1,4 +1,4 @@ -# (WIP) Next gen moonbit-docs +# Next gen moonbit-docs A new MoonBit docs framework based on Sphinx. @@ -45,6 +45,13 @@ PATH=$PATH:/usr/local/texlive/2024/bin/universal-darwin/ make latexpdf open ./_build/latex/moonbitdocument.pdf ``` +For Markdown: + +```bash +pip install sphinx-markdown-builder +make markdown +``` + ### Update translation template ```bash diff --git a/next/requirements.txt b/next/requirements.txt index 164e7248..39258d21 100644 --- a/next/requirements.txt +++ b/next/requirements.txt @@ -31,6 +31,7 @@ sphinx-autobuild==2024.10.3 sphinx-book-theme==1.1.3 sphinx-copybutton==0.5.2 sphinx-intl==2.3.0 +sphinx-markdown-builder==0.6.7 sphinxcontrib-applehelp==2.0.0 sphinxcontrib-devhelp==2.0.0 sphinxcontrib-htmlhelp==2.1.0