-
Notifications
You must be signed in to change notification settings - Fork 28
[docs-infra] Add Markdown Alternates #720
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
Draft
dav-is
wants to merge
11
commits into
davis/add-docs-infra-docs
Choose a base branch
from
davis/add-markdown-version
base: davis/add-docs-infra-docs
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.
Draft
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
Bundle size report
Check out the code infra dashboard for more information about this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
PR: out-of-date
The pull request has merge conflicts and can't be merged.
scope: docs-infra
Involves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305).
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.
For each
page.mdx
, we should generate a markdown alternate.e.g.
/app/components/checkbox/page.mdx
will be availiable at/components/checkbox
with a markdown alternate stored at/components/checkbox.md
To publish this markdown, each page should add this to the head:
and this to HTTP headers so the alternate can be discovered using a HEAD request:
A link should also be added somewhere directly in the page.
If the server is capable, it should also support
Accept: text/markdown
andAccept: text/plain
To install, create
app/[...markdownPath]/route.ts
:This route exports
generateStaticParams
with a list of all expected.md
files.Add to your build script in the docs
package.json
: