Porting documentation to Docusaurus
See original GitHub issueRef #5209, this issue will work as a base for planning the work of creating a Docusaurus documentation website for create-react-app
.
Task list
An initial task overview might look like this:
- Initial setup of Docusaurus (@amyrlam / #5227)
- Removing the blog feature from Docusaurus (@selbekk / #5239)
- Removing sample content and pages (@selbekk / #5242)
- Updating the
siteConfig.js
file with correct names (@selbekk / #5243) - Add favicons and og-images from the reactjs.org page (@selbekk / #5244)
- Set up basic documentation structure (@selbekk / #5245)
- Change the color scheme to something more React-y (@selbekk / #5249)
- Update footer links (@selbekk / #5251)
- Create an initial front page design (@selbekk / #5341)
- Create getting started docs (@selbekk / #5344)
- Create user guide docs (@selbekk / #5347)
- Split up user guide docs into sections (@selbekk / #5347)
- Set up Algolia search https://github.com/facebook/create-react-app/pull/5551
- Change the mobile navigation colors (@selbekk / #5398)
- Improve visibility of text links in docs (@selbekk / #5357)
- Add some more content to the landing page (@selbekk / #5398)
- Launch site on Github Pages (?)
- Update GitHub readmes etc to reference the website
- Decide what to do with the template README
- Update bit.ly/CRA-PWA link
This task list will be updated, edited and changed as we come up with more tasks, or split larger ones up into smaller ones.
Documentation structure
There are many ways of structuring the content found in this repo, but I think a good first approach is to split it into two parts:
- Getting started (some of the information from the README.md file can go here)
- User Guide (as is, for now)
From there, we can split it up into more narrow “groups”, if we find it appropriate and helpful for the user.
Issue Analytics
- State:
- Created 5 years ago
- Reactions:1
- Comments:24 (21 by maintainers)
Top Results From Across the Web
Docs Introduction - Docusaurus
The docs feature provides users with a way to organize Markdown files in a hierarchical format.
Read more >Docusaurus · Test Site - GitHub Pages
In your project repo, all of your documentation files should be placed inside a docs folder. Any blog posts should be inside a...
Read more >Deploy a Docusaurus site · Cloudflare Pages docs
Select the new GitHub repository that you created and, in the Set up builds and deployments section, select Docusaurus as your Framework preset....
Read more >Search for Documentation Sites - Typesense
Here's (opens new window) Docusaurus' documentation docsearch config. · Here's (opens new window) Typesense (Vuepress-based) Documentation Site's ...
Read more >Richer API documentation with Redoc and Docusaurus
Docusaurus · Initialise a Docusaurus project · Make your OpenAPI spec available to your project · Add it as a custom field in...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
We should probably make the docs searchable as well, but I think we can release this as is now.
@amyrlam has done some research here. We need to configure Docusaurus and then we need to set up Algolia’s DocSearch.
The latter, which will create an API key, is probably best done by one of the maintainers. Once it’s done, send me the API key, and I’ll create a pull request enabling the search feature.
Versioning is probably something we’ll want eventually. I created an issue so we don’t forget about this: https://github.com/facebook/create-react-app/issues/5560