-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
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
Improve the initial templates #4079
Comments
Fellows to document what would be the good UI. You can come up with a general meaningful UI with minimum content, links and submit a PR for review. General guidelines:
There is another feature were we need to build a template corresponding to a particular theme like Bootstrap, Tailwind. This issue can serve as a precursor for that task. |
The idea for me would to be create a minimalistic documentation site for Docusaurus site itself, so that it kind of serve as a realistic example. We want to spark immediate joy to the user and let him try Docusauurs in a step by step guide where each action provides immediate gratification by seeing the result of the action. I don't think the user needs to understand everything about Docusaurus at the end of this tutorial, but be convinced that this is a powerful tool and quite simple to use. What about using the following docs/sidebar? module.exports = {
docs: {
"Docusaurus Tutorial": [
"Docusaurus Intro", // Basic infos + install steps
"Create a doc", // + how to add it to the sidebar
"Create a page", // jsx + md
"Create a post",
"Markdown Features", // basic markdown + some MDX explanations
"Thank you" // end of tutorial, show what's next?
],
Extras: [
"Deploy your site", // configure a bit + build + deploy to GH pages?
"Translate your site", // very basic version, like add "fr" language + put a copy `docs/intro.md` to `i18n/fr/plugin-docs/intro.md` + run `yarn start --locale fr`
"Manage versions" // just run the versioning cli + restart the site with yarn start
]
}
}; I suggest the initial PR (#4302) focus first on the "Docusaurus tutorial" category. Once it's merged we can add the Extras category later? Do you think this is a good structure? |
🚀 Feature
We want to give a good impression to users when they first try Docusaurus, and improve:
It was proposed (#3489) that we make the initial docs more representative of a real-world doc site and be a bit more opinionated:
We also have some content duplication in templates, as each template MD docs are very similar and copy/paste. We should find a way to create once this content for all sites instead of keeping them in sync manually.
For users that really want an empty/minimal Docusaurus site, we could add a new separate minimalistic template.
The text was updated successfully, but these errors were encountered: