New HTML Docs #258
Open
New HTML Docs #258
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces an alternative documentation setup built using custom HTML and JavaScript to address limitations found with MkDocs. The new system includes advanced features such as ontology tree views, pattern zooming, save functionality, and a more dynamic search experience. It provides greater flexibility for interactive and visualization-heavy documentation.
A GitHub Action is also included to automate the deployment of these custom docs. It builds and publishes the HTML files to the ..../pmdcodocs/....html, making them accessible via GitHub Pages.
Please cross-verify the action before merging to ensure compatibility with the main branch and confirm that the output is correctly placed and renders as expected.
The Navigator.yaml file is the structural backbone of the website. build_all.py is the HTML code generator. run_all.py will run the code, and auto creates HTML documents. In the .MD I introduced some tags, which will guide the code on which steps to take.