[CLI] - Created a template for a documentation website (Resolves #4)
Still need support for Algolia search in the template.
Includes support for:
GitHub link
Discord Link
Sponsor Link
Pub API docs link
Contributors list
Global navigation menu
Table of Contents per page
Toggle between light and dark mode
Added working CLI tests for the docs template generation.
Source code includes the following template sections:
/packages/template_docs -> the source of truth for the docs template, in a runnable state
/packages/static_shock_cli/templates/docs -> the docs template with mustache variables for Mason
/packages/static_shock_cli/lib/templates/docs.bundle -> the final bundled docs template that's inflated at runtime
Future templates will need the same pieces as above.
The process for updating a template is as follows:
Alter the runnable template (e.g., /packages/template_docs) until it behaves as intended.
Copy the runnable source files (e.g., /packages/template_docs) to the template source (e.g., /packages/static_shock_cli/templates/docs). Replace all hard-coded values with mustache variables. Replace all Jinja brackets with escaped versions: {{#mustacheCase}} stuff {{/mustacheCase}}
Run mason bundle to create a new bundle from the template source. Move that bundle into /packages/static_shock_cli/lib/templates/.
[CLI] - Created a template for a documentation website (Resolves #4)
Still need support for Algolia search in the template.
Includes support for:
Added working CLI tests for the docs template generation.
Source code includes the following template sections:
Future templates will need the same pieces as above.
The process for updating a template is as follows:
/packages/template_docs
) until it behaves as intended./packages/template_docs
) to the template source (e.g.,/packages/static_shock_cli/templates/docs
). Replace all hard-coded values with mustache variables. Replace all Jinja brackets with escaped versions:{{#mustacheCase}} stuff {{/mustacheCase}}
mason bundle
to create a new bundle from the template source. Move that bundle into/packages/static_shock_cli/lib/templates/
.