Skip to content

Explain how to build and serve the documentation #3

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

Open
RLesur wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −0
Open

Explain how to build and serve the documentation #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d89f2f8
explain how to update the documentation
RLesur Jun 16, 2022
524c7ff
reference GitHub Pages documentation
RLesur Jun 16, 2022
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ you.
will know what to expect. You may also want to update the URLs
above to match your repository.

4. [ ] **Build and serve the documentation**: this template provides
a [tool][doc generator] to build an HTML documentation. Execute
`make docs` to update the documentation. The documentation website
files are located in the `docs` folder and can be published with
GitHub Pages (see the GitHub documentation on
[configuring GitHub Pages][GitHub Pages]).

[doc generator]: ./.tools/docs.lua
[GitHub Pages]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

License
------------------------------------------------------------------

Expand Down