-
Notifications
You must be signed in to change notification settings - Fork 5
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
Create demo Jekyll based on markdown files found in the CoMPAS repositories #186
Comments
After playing around with MKDocs, I believe that we can better make use of Jekyll (or Hugo, suggested by Tamas). Hugo is faster to generate HTML pages, but this is not really worth it, since we only have a few pages. |
Jekyll: Hugo: MKdocs: |
Todo: Upload the script to get the markdown files. |
Tested here: https://openscd.github.io/Documentation/ |
Hypothesis; we believe that Jeckyll can publish all documentation at once on Github
Test; to verify that, we will make an Example Jeckyll
Metric; and measure if we can see all existing documentation in the current repositories
Criteria; we are right if:
No documentation changes are needed
Files are close to the code
Easy to read
Easy to navigate
Theme to use:
https://jekyllthemes.io/theme/bulma
Acceptance criteria:
Existing documentation
Generate pages dynamically based on the MD files found in the repositories
Convert https://com-pas.github.io/compas-architecture/ into the Bulma theme
Spike: 8 hours (excluding sharing) + 4 hours sharing
Outcome: example setup with the plug-ins / session to discuss the results
The text was updated successfully, but these errors were encountered: