Skip to content

Create demo Jekyll based on markdown files found in the CoMPAS repositories #186

@Sander3003

Description

@Sander3003

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

Status

To do

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions