Implement anchors for CLI flags, and automatically fetch --help #102
+210
−303
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
biome seems to detect false unused variable warnings in astro components. astro recommends disabling these warnings, so i've done so in this commit. https://astro-tips.dev/tips/biome/
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.
This PR is two changes in one:
The result looks like this. Each line beginning with
#is a hyperlink to that line. The anchor links work as expected when clicking on the same page and when navigating to the page from elsewhere.One thing to be aware of with the automatic fetching of README.md is that this will always get the latest version from master. This might be undesirable because re-builds of the same docs could fetch different copies of README.md. Also, it may show options which are not yet available in an official version.
I've added a
LYCHEE_VERSIONvariable for specifying the version which it fetches from, but I don't know where this variable should be defined - in CI maybe?Also, it would be easy to split this PR into two if it would be easier to discuss the two changes separately.
Related to #95