Skip to content
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

README.mdx #7

Open
jonathantneal opened this issue Sep 17, 2020 · 0 comments
Open

README.mdx #7

jonathantneal opened this issue Sep 17, 2020 · 0 comments

Comments

@jonathantneal
Copy link

Octavo could switch from doc.mdx to README.mdx.

GitHub supports README.mdx files and gives them the same treatment as README.md files when viewing a directory. NPM also supports README.mdx files.

In both cases, they are displayed static, meaning the react components themselves are not hydrated. Self-closing elements, like the knobs component, would not be rendered at all in the static view, which may actually be ideal.

Using README.mdx seems like a better fallback pattern, and it would result in less repetition than having both docs.mdx and README.mdx files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant