From de1697a6c62468b9f2e554488327fe69eb712a12 Mon Sep 17 00:00:00 2001 From: rami3l Date: Wed, 18 Dec 2024 18:10:25 +0800 Subject: [PATCH 1/3] chore(next): rename `README` to `README.md` --- next/{README => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename next/{README => README.md} (100%) diff --git a/next/README b/next/README.md similarity index 100% rename from next/README rename to next/README.md From 0804dcf6f7aff4770371df6f6e93c9dc425be60c Mon Sep 17 00:00:00 2001 From: rami3l Date: Wed, 18 Dec 2024 18:10:25 +0800 Subject: [PATCH 2/3] deps(next): import `sphinx-markdown-builder` --- next/requirements.txt | 1 + 1 file changed, 1 insertion(+) 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 From 88f60ca86d732624e47a8d38c76fe04bd125f569 Mon Sep 17 00:00:00 2001 From: rami3l Date: Wed, 18 Dec 2024 18:10:25 +0800 Subject: [PATCH 3/3] docs(next/readme): add build instructions for the Markdown backend --- next/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/next/README.md b/next/README.md index 5c78a33a..61010093 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,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