Document how we store our source code #6
Merged
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
Rather than having to manually manage and update the list of standards
on the homepage, it would be nice if we can get Jekyll to do it for us.
To do that, we first mark everything in `/standards/` as a standard
from Jekyll's config. We can then filter `site.pages` to just get those
items, group them by their `category`, and render the list of standards
with appropriate headings.
Unfortunately, the headings generated here are rendered using Liquid
and so don't render correctly in the table of contents sidebar. This is
because we're unable (so far as I can tell) to parse the Liquid tags
before running `markdownify`. To avoid rendering garbage headings,
then, we apply the [`{:.no_toc}` Kramdown
attribute](https://kramdown.gettalong.org/converter/html.html#toc)
(which excludes them from) the table of contents.
This also adds an appropriate category to `storing-source-code.md`, and
adds an example to the index.
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.
We should document how we store source code and use GitHub.
This also adds an autogenerated list of standards to the homepage.