You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
After playing around with MKDocs, I believe that we can better make use of Jekyll (or Hugo, suggested by Tamas).
Both do the same.
Hugo is faster to generate HTML pages, but this is not really worth it, since we only have a few pages.
Jekyll offers plugins where we can extend the usage
Jekyll:
Pros: Widely used and allows plug-ins
Cons: Slower build time
Hugo:
Pro's: Fastest
Con's: No plug-in
MKdocs:
Pro's:
Con's: No template generator
Sander3003
changed the title
Create demo with MK docs
Create demo Jeckyll based on markdown files found in the CoMPAS repositories
Oct 30, 2023
pascalwilbrink
changed the title
Create demo Jeckyll based on markdown files found in the CoMPAS repositories
Create demo Jekyll based on markdown files found in the CoMPAS repositories
Dec 13, 2023
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: