-
Notifications
You must be signed in to change notification settings - Fork 134
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.
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: add "How to Build Shield Documentation" #862
Conversation
admin/HowToBuildDocs.md
Outdated
@@ -0,0 +1,26 @@ | |||
# How to Build Shield Documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use Material for MkDocs for implementation. It is better to add the description in this section that includes the line as follows.
https://squidfunk.github.io/mkdocs-material/getting-started/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added.
admin/HowToBuildDocs.md
Outdated
|
||
```consolse | ||
mkdocs serve | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Command mkdocs gh-deploy
is also good for manual implementation if there is a problem. Of course, I think it needs administrator access.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added.
admin/HowToBuildDocs.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have previously named the files as follows.
how_to_build_docs.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
b28d3b6
to
16fb1e4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! 🥀
Description
Checklist: