From ec659e073cf0ea897dc2c3f60e7f0162221c6062 Mon Sep 17 00:00:00 2001 From: rami3l Date: Wed, 18 Dec 2024 17:53:33 +0800 Subject: [PATCH] docs(next/readme): add build instructions for the Markdown backend --- next/README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/next/README.md b/next/README.md index 5c78a33a..1f12ba65 100644 --- a/next/README.md +++ 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,9 +45,16 @@ PATH=$PATH:/usr/local/texlive/2024/bin/universal-darwin/ make latexpdf open ./_build/latex/moonbitdocument.pdf ``` +For Markdown: + +```bash +pip install sphinx-markdown-builder +sphinx-build -M markdown . ./_build +``` + ### Update translation template ```bash make gettext sphinx-intl update -p _build/gettext -l zh_CN -``` \ No newline at end of file +```