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

Docusaurus site to break up the README? #1099

Closed
cspotcode opened this issue Aug 10, 2020 · 1 comment
Closed

Docusaurus site to break up the README? #1099

cspotcode opened this issue Aug 10, 2020 · 1 comment

Comments

@cspotcode
Copy link
Collaborator

@blakeembrey how do you feel about having a Docusaurus site for ts-node, letting us break up the README into multiple pages? Motivation is to improve the appeal and discoverability of the information in our README, since it's a bit long.

I've used Docusaurus at work, and it's the simplest way I know to render markdown into an attractive docs site. You create docs/*.md files and each is rendered as a page. It'll be easy to setup on Github Actions. It could live at https://TypeStrong.github.io/ts-node

On the other hand, I don't like that the npmjs.com README will be different than the documentation site. We'd either have to make the readme empty, or somehow duplicate high-profile documentation between the docs site and the README. Or some smart copy-pasting script to keep them in sync? None of those ideas sound good.

Alternatively, maybe we add a table of contents to the README with http://npm.im/markdown-toc?

@cspotcode
Copy link
Collaborator Author

Initial implementation is merged; will keep iterating on the pages till it's ready to be "official."

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

No branches or pull requests

1 participant