-
Notifications
You must be signed in to change notification settings - Fork 1
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
Adapt DocCardList for the Teleport docs site #86
Draft
ptgott
wants to merge
1
commit into
main
Choose a base branch
from
paul.gottschling/29-toc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
Amplify deployment status
|
Partially addresses #29 Swizzle the Docusaurus-native `DocCardList` component and adapt it to suit the Teleport docs site. Since we prefer a more text-oriented approach to components, edit `DocCardList` to return a plain `ul`, rather than tiles. Since the `DocCardList` component is a Docusaurus-native alternative to our `remark-toc` plugin, edit `remark-toc` to return a `DocCardList` instead of querying the filesystem to generate a table of contents. Once we replace all `(!toc!)` expressions with `<DocCardList />` elements, we can remove `remark-toc` entirely. Also make `DocCardList` an MDX component so docs authors don't need to add `import` statements to the top of a docs page.
ptgott
force-pushed
the
paul.gottschling/29-toc
branch
from
January 3, 2025 20:59
6745cb4
to
3960825
Compare
avatus
approved these changes
Jan 3, 2025
Getting a bunch of errors like this in the Amplify preview build:
I'm guessing this is because the preview site doesn't include |
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.
Partially addresses #29
Swizzle the Docusaurus-native
DocCardList
component and adapt it to suit the Teleport docs site. Since we prefer a more text-oriented approach to components, editDocCardList
to return a plainul
, rather than tiles.Since the
DocCardList
component is a Docusaurus-native alternative to ourremark-toc
plugin, editremark-toc
to return aDocCardList
instead of querying the filesystem to generate a table of contents. Once we replace all(!toc!)
expressions with<DocCardList />
elements, we can removeremark-toc
entirely.Also make
DocCardList
an MDX component so docs authors don't need to addimport
statements to the top of a docs page.