ntno / mkdocs-terminal

monospace theme for MkDocs
https://ntno.github.io/mkdocs-terminal/
MIT License
96 stars 3 forks source link

DRAFT: code highlighting with hljs #148

Open ntno opened 4 weeks ago

ntno commented 4 weeks ago

wip for #81 todo: consider adding option to theme via feature flag not sure whether we need this or we can just make a better example documentation

https://highlightjs.readthedocs.io/en/latest/readme.html#in-the-browser https://highlightjs.readthedocs.io/en/latest/readme.html#common-js-omit-in-toc https://highlightjs.org/download

Description

Describe the purpose of this PR along with any background information and the impacts of the proposed change. For the benefit of the community, please do not assume prior context.

Provide details that support your chosen implementation, including: breaking changes, alternatives considered, changes to the API, etc.

If the UI is being changed, please provide before/after screenshots.

References

Include any links supporting this change such as a:

  • GitHub Issue/PR number addressed or fixed
  • Related pull requests/issues from other repos

If there are no references, simply delete this section.

Testing

Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If there are existing unit and/or integration test suites, tests should be added for new functionality and existing tests should complete without errors.

Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.

Also include details of the environment this PR was developed in (language/platform/browser version).

Checklist

ntno commented 4 weeks ago

Screen Shot 2024-08-13 at 11 19 05 PM code highlighted but lost the custom background color