Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add VitePress generation option, set as default #140

Merged
merged 18 commits into from
Mar 15, 2024

Conversation

WaitingIdly
Copy link
Collaborator

@WaitingIdly WaitingIdly commented Mar 14, 2024

changes in this PR

  • centralize missingLangKeys.
  • remove documentation format from Admonition enum.
  • remove #!groovy inline shebang from field explanation generation.
  • changes the english text of the groovyscript.wiki.defaultPackage lang key.
  • adds the ability to change what format code is generated in, set in Documentation.
  • adds VitePress code generation, which generate with these main changes:
    • admonitions (here named "custom containers") have a start and end location, marked via some number of :, instead of just a start location. the format for determining color and symbol are also slightly changed.
    • code blocks for the Identifier focus the desired line
    • the !navigation.md files, which were used to generate the site map for the docs, are not needed here
  • changes the default code generation to VITEPRESS. if changed back to MKDOCS_MATERIAL, should generate basically the same docs.

you can view the currently active VitePress docs here: https://cleanroommc.com/groovy-script/

@brachy84 brachy84 merged commit 4a29c6d into CleanroomMC:master Mar 15, 2024
@WaitingIdly WaitingIdly deleted the maybe-more-doc-stuff branch March 15, 2024 14:40
@brachy84 brachy84 added enhancement New feature or request documentation Improvements or additions to documentation labels Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants