You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
Octavo could switch from
doc.mdx
toREADME.mdx
.GitHub supports
README.mdx
files and gives them the same treatment asREADME.md
files when viewing a directory. NPM also supportsREADME.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 bothdocs.mdx
andREADME.mdx
files.The text was updated successfully, but these errors were encountered: