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.

Sign up for GitHub

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

docs(next/readme): add build instructions for the Markdown backend #369

Merged
merged 3 commits into from
Dec 18, 2024
Merged

docs(next/readme): add build instructions for the Markdown backend #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de1697a
chore(next): rename `README` to `README.md`
rami3l Dec 18, 2024
0804dcf
deps(next): import `sphinx-markdown-builder`
rami3l Dec 18, 2024
88f60ca
docs(next/readme): add build instructions for the Markdown backend
rami3l Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion next/README → next/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (WIP) Next gen moonbit-docs
# Next gen moonbit-docs

A new MoonBit docs framework based on Sphinx.

Expand Down Expand Up @@ -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
rami3l marked this conversation as resolved.
Show resolved Hide resolved
```

### Update translation template

```bash
Expand Down
1 change: 1 addition & 0 deletions next/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading