SoarGroup / SoarGroup/SoarGroup.github.io
Syntax Highlighting on Website for Soar Code
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 16
- Forks
- 7
- Avg merge
- 5d 18h
- Merged PRs (30d)
- 1
Description
It would be nice, if the Soar code snippets on the website would have syntax highlighting.
According to the MkDocs Material docs relies on pygments to highlight the syntax of code blocks. Unfortunately, pygments does not have a Soar lexer, yet.
I have created a pygments lexer for Soar in my fork, but this needs more work until it might be in a state which is acceptable to be merged in pygments.
Tasks for native highlighting for Soar code via mkdocs:
- Complete Lexer in fork
- Merge Soar lexer in upstream pygments
- Update mkdocs material version once pygments version is updated.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the MkDocs Material syntax-highlighting documentation and the Soar lexer in the linked Pygments fork. The work is complete when the lexer is accepted upstream and the website updates its MkDocs Material version to use the available Pygments release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100