Add a remark plugin for generating a TOC menu #483
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
avatus
previously approved these changes
Jul 9, 2024
server/remark-toc.ts
Outdated
| }, new Set()); | ||
|
|
||
| // Add rows to the menu page for non-menu pages. | ||
| let entries = []; |
There was a problem hiding this comment.
nit: i don't see this reference updated anywhere so we can change to const
There was a problem hiding this comment.
👍 Fixed in 74911f2 (along with a .remarkrc update to stop this from breaking the remark linter).
As we reorganize the documentation, it becomes cumbersome to manually change lists of links to pages within the documentation, e.g., in table of contents pages for subsections of the docs. This change adds a remark plugin for generating a list of links to pages in the current directory. The plugin works similarly to `remark-includes`, and accesses the local filesystem during the docs build. It replaces any lines consisting of `(!toc!)` with a list of links to pages in the current directory. The assumption is that a category page within a directory can use this to list contents.
ptgott
force-pushed
the
paul.gottschling/2024-07-8-remark-toc
branch
from
32d7d3b
to
74911f2
Compare
avatus
approved these changes
Jul 9, 2024
travelton
pushed a commit
that referenced
this pull request
Aug 26, 2024
As we reorganize the documentation, it becomes cumbersome to manually change lists of links to pages within the documentation, e.g., in table of contents pages for subsections of the docs. This change adds a remark plugin for generating a list of links to pages in the current directory. The plugin works similarly to `remark-includes`, and accesses the local filesystem during the docs build. It replaces any lines consisting of `(!toc!)` with a list of links to pages in the current directory. The assumption is that a category page within a directory can use this to list contents.
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.
As we reorganize the documentation, it becomes cumbersome to manually change lists of links to pages within the documentation, e.g., in table of contents pages for subsections of the docs. This change adds a remark plugin for generating a list of links to pages in the current directory.
The plugin works similarly to
remark-includes, and accesses the local filesystem during the docs build. It replaces any lines consisting of(!toc!)with a list of links to pages in the current directory. The assumption is that a category page within a directory can use this to list contents.