Document anchor/alias functionality #316
Merged
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.
After seeing the conversation in #271, I decided to quickly go in and document this for people to find easier. I didn't find this syntax very intuitive at first, and it took me a while to wrap my head around it. I wouldn't expect a more casual user to catch on immediately, so I tried to explain it in the most clear way I could, making no assumptions. I also coined the term "subpreset" for this, primarily because it makes it very obvious when skimming the pages list if you're trying to find a feature like this, but also I just thought it sounded cool :p
As a side note, you might wanna update some things to make it easier to contribute to the docs. The theme
rundocs/jekyll-rtd-theme
appears to have disappeared, alongside the entire rundocs account. No idea what happened, but using a reupload by settingremote_theme: clearpathrobotics/jekyll-rtd-theme@main
fixed the problem. Although, I also had to nuke theGemfile.lock
file, let it generate a new one, then manually change the two instances of jekyll from3.9.0
to3.9.2
. Some weird old bug involving updating to Ruby 3. I'm unfamiliar with Gemfiles and such, but that doesn't feel like a real solution, so I didn't wanna try to PR that. Especially because I also couldn'tjekyll serve
, something about webrick... but at that point, the site had built, and opening the file directly was good enough to preview my changes.