Moose Syntax Highlighting #30123
Open
Moose Syntax Highlighting #30123
Conversation
This file contains 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
zachmprince
requested review from
joshuahansel,
lindsayad,
GiudGiud,
grmnptr and
roystgnr
as code owners
loganharbour
requested changes
Mar 18, 2025
|
Job Documentation, step Docs: sync website on b94007b wanted to post the following: View the site here This comment will be updated on new commits. |
|
Job Coverage, step Generate coverage on b94007b wanted to post the following: Framework coverage
Modules coverageCoverage did not change Full coverage reportsReports
This comment will be updated on new commits. |
||||||||||||||||||||||||||
|
Job Documentation on b94007b : invalidated by @zachmprince Fetch error that's been resolved |
|
Job Precheck, step Versioner verify on 2f58e15 wanted to post the following: Versioner templatesFound 16 templates, 0 failed Versioner versionsFound 10 packages, 2 changed, 0 failed
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reason
Closes #30112
Design
The modification of the
prism.min.jsis the implementation of the syntax highlighting. The line for the moose input part was generated from my prism fork. Since I wanted to look more like the VSCode style, I modified the moose.css to include colors seen in the vscode theme that many of us use. Here is a snippet of what the highlighting looks like:I went a little above-and-beyond, so to speak, and added links and tooltips to page documentation recognized by the syntax. For instance, clicking on
[Functions]will take you to the Functions syntax page andParsedFunctionwill take you to ParsedFunction.md. Also, hovering over the parameters and the class name (ParsedMaterial) will show the parameter/class description.This is my first time writing JavaScript, so please go easy on my ignorance on how to code in that. All the python code and custom JS file is to support the syntax linking and description display. If we don't end up liking that, this is a much simpler PR.
Impact
The runtime for the doc build seems about the same. Pages with moose input listings do show some confusing text on the initial load, but quickly turn into the right thing once the JS is done. I don't see much other down sides other than we are dependent on a fork prism to get the syntax highlighting regex, but that is well documented in the prism.min.js file.