yan
/
docusaurus
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
docusaurus/packages/create-docusaurus/templates/shared/docs/tutorial-basics/congratulations.md

24 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

feat(v2): Improve the initial templates #4302 (#4320) * feat: add getting started doc at classic inital templates * fix: improve the contents of getting started page * fix: fix slug routing * fix: rename gettingStarted to getting-started and re-adjust the content * feat: add markdown-features docs * feat: add a page on how to create a simple document * feat: add a page on how to create pages * feat: add create a post doc * feat: add thank you page with whats next * feat : update sidebar.js * feat : add introduction content * feat : add self hosting content * feat : add GitHub pages content * fix : remove automatically deploying with github actions content * feat : add deploying to netlify * feat : add Translate your site * add : Manage versions * fix : formatted docs with prettier * Revert "fix : formatted docs with prettier" This reverts commit af8c0b48 * run prettier to init templates with fixes * complete new init template * rename manage-docs-versions * change wording * refresh config file * rework init template homepage * minor changes Co-authored-by: Lisa Chandra <52909743+lisa761@users.noreply.github.com> Co-authored-by: Javid <singularity.javid@gmail.com> Co-authored-by: ShinteiMai <stevenhanselgo@gmail.com> Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-17 10:59:01 -04:00
---
feat(v2): auto-generated sidebars, frontmatter-less sites (#4582) * POC of autogenerated sidebars * use combine-promises utility lib * autogenerated sidebar poc working * Revert "autogenerated sidebar poc working" This reverts commit c81da980 * POC of auto-generated sidebars for community docs * update tests * add initial test suite for autogenerated sidebars + fix some edge cases * Improve autogen sidebars: strip more number prefixes in folder breadcrumb + slugs * fix typo! * Add tests for partially generated sidebars + fix edge cases + extract sidebar generation code * Ability to read category metadatas file from a file in the category * fix tests * change position of API * ability to extract number prefix * stable system to enable position frontmatter * fix tests for autogen sidebar position * renamings * restore community sidebars * rename frontmatter position -> sidebar_position * make sidebarItemsGenerator fn configurable * minor changes * rename dirPath => dirName * Make the init template use autogenerated sidebars * fix options * fix docusaurus site: remove test docs * add _category_ file to docs pathsToWatch * add _category_ file to docs pathsToWatch * tutorial: use sidebar_position instead of file number prefixes * Adapt Docusaurus tutorial for autogenerated sidebars * remove slug: / * polish the homepage template * rename _category_ sidebar_position to just "position" * test for custom sidebarItemsGenerator fn * fix category metadata + add link to report tutorial issues * fix absolute path breaking tests * fix absolute path breaking tests * Add test for floating number sidebar_position * add sidebarItemsGenerator unit tests * add processSidebars unit tests * Fix init template broken links * windows test * increase code translations test timeout * cleanup mockCategoryMetadataFiles after windows test fixed * update init template positions * fix windows tests * fix comment * Add autogenerated sidebar items documentation + rewrite the full sidebars page doc * add useful comment * fix code block title
2021-04-15 10:20:11 -04:00
sidebar_position: 6
feat(v2): Improve the initial templates #4302 (#4320) * feat: add getting started doc at classic inital templates * fix: improve the contents of getting started page * fix: fix slug routing * fix: rename gettingStarted to getting-started and re-adjust the content * feat: add markdown-features docs * feat: add a page on how to create a simple document * feat: add a page on how to create pages * feat: add create a post doc * feat: add thank you page with whats next * feat : update sidebar.js * feat : add introduction content * feat : add self hosting content * feat : add GitHub pages content * fix : remove automatically deploying with github actions content * feat : add deploying to netlify * feat : add Translate your site * add : Manage versions * fix : formatted docs with prettier * Revert "fix : formatted docs with prettier" This reverts commit af8c0b48 * run prettier to init templates with fixes * complete new init template * rename manage-docs-versions * change wording * refresh config file * rework init template homepage * minor changes Co-authored-by: Lisa Chandra <52909743+lisa761@users.noreply.github.com> Co-authored-by: Javid <singularity.javid@gmail.com> Co-authored-by: ShinteiMai <stevenhanselgo@gmail.com> Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-17 10:59:01 -04:00
---
feat(v2): auto-generated sidebars, frontmatter-less sites (#4582) * POC of autogenerated sidebars * use combine-promises utility lib * autogenerated sidebar poc working * Revert "autogenerated sidebar poc working" This reverts commit c81da980 * POC of auto-generated sidebars for community docs * update tests * add initial test suite for autogenerated sidebars + fix some edge cases * Improve autogen sidebars: strip more number prefixes in folder breadcrumb + slugs * fix typo! * Add tests for partially generated sidebars + fix edge cases + extract sidebar generation code * Ability to read category metadatas file from a file in the category * fix tests * change position of API * ability to extract number prefix * stable system to enable position frontmatter * fix tests for autogen sidebar position * renamings * restore community sidebars * rename frontmatter position -> sidebar_position * make sidebarItemsGenerator fn configurable * minor changes * rename dirPath => dirName * Make the init template use autogenerated sidebars * fix options * fix docusaurus site: remove test docs * add _category_ file to docs pathsToWatch * add _category_ file to docs pathsToWatch * tutorial: use sidebar_position instead of file number prefixes * Adapt Docusaurus tutorial for autogenerated sidebars * remove slug: / * polish the homepage template * rename _category_ sidebar_position to just "position" * test for custom sidebarItemsGenerator fn * fix category metadata + add link to report tutorial issues * fix absolute path breaking tests * fix absolute path breaking tests * Add test for floating number sidebar_position * add sidebarItemsGenerator unit tests * add processSidebars unit tests * Fix init template broken links * windows test * increase code translations test timeout * cleanup mockCategoryMetadataFiles after windows test fixed * update init template positions * fix windows tests * fix comment * Add autogenerated sidebar items documentation + rewrite the full sidebars page doc * add useful comment * fix code block title
2021-04-15 10:20:11 -04:00
# Congratulations!
feat(v2): Improve the initial templates #4302 (#4320) * feat: add getting started doc at classic inital templates * fix: improve the contents of getting started page * fix: fix slug routing * fix: rename gettingStarted to getting-started and re-adjust the content * feat: add markdown-features docs * feat: add a page on how to create a simple document * feat: add a page on how to create pages * feat: add create a post doc * feat: add thank you page with whats next * feat : update sidebar.js * feat : add introduction content * feat : add self hosting content * feat : add GitHub pages content * fix : remove automatically deploying with github actions content * feat : add deploying to netlify * feat : add Translate your site * add : Manage versions * fix : formatted docs with prettier * Revert "fix : formatted docs with prettier" This reverts commit af8c0b48 * run prettier to init templates with fixes * complete new init template * rename manage-docs-versions * change wording * refresh config file * rework init template homepage * minor changes Co-authored-by: Lisa Chandra <52909743+lisa761@users.noreply.github.com> Co-authored-by: Javid <singularity.javid@gmail.com> Co-authored-by: ShinteiMai <stevenhanselgo@gmail.com> Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-17 10:59:01 -04:00
feat(v2): auto-generated sidebars, frontmatter-less sites (#4582) * POC of autogenerated sidebars * use combine-promises utility lib * autogenerated sidebar poc working * Revert "autogenerated sidebar poc working" This reverts commit c81da980 * POC of auto-generated sidebars for community docs * update tests * add initial test suite for autogenerated sidebars + fix some edge cases * Improve autogen sidebars: strip more number prefixes in folder breadcrumb + slugs * fix typo! * Add tests for partially generated sidebars + fix edge cases + extract sidebar generation code * Ability to read category metadatas file from a file in the category * fix tests * change position of API * ability to extract number prefix * stable system to enable position frontmatter * fix tests for autogen sidebar position * renamings * restore community sidebars * rename frontmatter position -> sidebar_position * make sidebarItemsGenerator fn configurable * minor changes * rename dirPath => dirName * Make the init template use autogenerated sidebars * fix options * fix docusaurus site: remove test docs * add _category_ file to docs pathsToWatch * add _category_ file to docs pathsToWatch * tutorial: use sidebar_position instead of file number prefixes * Adapt Docusaurus tutorial for autogenerated sidebars * remove slug: / * polish the homepage template * rename _category_ sidebar_position to just "position" * test for custom sidebarItemsGenerator fn * fix category metadata + add link to report tutorial issues * fix absolute path breaking tests * fix absolute path breaking tests * Add test for floating number sidebar_position * add sidebarItemsGenerator unit tests * add processSidebars unit tests * Fix init template broken links * windows test * increase code translations test timeout * cleanup mockCategoryMetadataFiles after windows test fixed * update init template positions * fix windows tests * fix comment * Add autogenerated sidebar items documentation + rewrite the full sidebars page doc * add useful comment * fix code block title
2021-04-15 10:20:11 -04:00
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
feat(v2): Improve the initial templates #4302 (#4320) * feat: add getting started doc at classic inital templates * fix: improve the contents of getting started page * fix: fix slug routing * fix: rename gettingStarted to getting-started and re-adjust the content * feat: add markdown-features docs * feat: add a page on how to create a simple document * feat: add a page on how to create pages * feat: add create a post doc * feat: add thank you page with whats next * feat : update sidebar.js * feat : add introduction content * feat : add self hosting content * feat : add GitHub pages content * fix : remove automatically deploying with github actions content * feat : add deploying to netlify * feat : add Translate your site * add : Manage versions * fix : formatted docs with prettier * Revert "fix : formatted docs with prettier" This reverts commit af8c0b48 * run prettier to init templates with fixes * complete new init template * rename manage-docs-versions * change wording * refresh config file * rework init template homepage * minor changes Co-authored-by: Lisa Chandra <52909743+lisa761@users.noreply.github.com> Co-authored-by: Javid <singularity.javid@gmail.com> Co-authored-by: ShinteiMai <stevenhanselgo@gmail.com> Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-17 10:59:01 -04:00
Docusaurus has **much more to offer**!
feat(v2): auto-generated sidebars, frontmatter-less sites (#4582) * POC of autogenerated sidebars * use combine-promises utility lib * autogenerated sidebar poc working * Revert "autogenerated sidebar poc working" This reverts commit c81da980 * POC of auto-generated sidebars for community docs * update tests * add initial test suite for autogenerated sidebars + fix some edge cases * Improve autogen sidebars: strip more number prefixes in folder breadcrumb + slugs * fix typo! * Add tests for partially generated sidebars + fix edge cases + extract sidebar generation code * Ability to read category metadatas file from a file in the category * fix tests * change position of API * ability to extract number prefix * stable system to enable position frontmatter * fix tests for autogen sidebar position * renamings * restore community sidebars * rename frontmatter position -> sidebar_position * make sidebarItemsGenerator fn configurable * minor changes * rename dirPath => dirName * Make the init template use autogenerated sidebars * fix options * fix docusaurus site: remove test docs * add _category_ file to docs pathsToWatch * add _category_ file to docs pathsToWatch * tutorial: use sidebar_position instead of file number prefixes * Adapt Docusaurus tutorial for autogenerated sidebars * remove slug: / * polish the homepage template * rename _category_ sidebar_position to just "position" * test for custom sidebarItemsGenerator fn * fix category metadata + add link to report tutorial issues * fix absolute path breaking tests * fix absolute path breaking tests * Add test for floating number sidebar_position * add sidebarItemsGenerator unit tests * add processSidebars unit tests * Fix init template broken links * windows test * increase code translations test timeout * cleanup mockCategoryMetadataFiles after windows test fixed * update init template positions * fix windows tests * fix comment * Add autogenerated sidebar items documentation + rewrite the full sidebars page doc * add useful comment * fix code block title
2021-04-15 10:20:11 -04:00
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
feat(v2): Improve the initial templates #4302 (#4320) * feat: add getting started doc at classic inital templates * fix: improve the contents of getting started page * fix: fix slug routing * fix: rename gettingStarted to getting-started and re-adjust the content * feat: add markdown-features docs * feat: add a page on how to create a simple document * feat: add a page on how to create pages * feat: add create a post doc * feat: add thank you page with whats next * feat : update sidebar.js * feat : add introduction content * feat : add self hosting content * feat : add GitHub pages content * fix : remove automatically deploying with github actions content * feat : add deploying to netlify * feat : add Translate your site * add : Manage versions * fix : formatted docs with prettier * Revert "fix : formatted docs with prettier" This reverts commit af8c0b48 * run prettier to init templates with fixes * complete new init template * rename manage-docs-versions * change wording * refresh config file * rework init template homepage * minor changes Co-authored-by: Lisa Chandra <52909743+lisa761@users.noreply.github.com> Co-authored-by: Javid <singularity.javid@gmail.com> Co-authored-by: ShinteiMai <stevenhanselgo@gmail.com> Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-17 10:59:01 -04:00
## What's next?
chore: backport retro compatible commits for the Docusaurus v2.1 release (#8033) Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com> Co-authored-by: Joshua Chen <sidachen2003@gmail.com> Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com> Co-authored-by: whiteand <andrewbeletskiy@gmail.com> Co-authored-by: yzhe819 <68207314+yzhe819@users.noreply.github.com> Co-authored-by: Ngô Quốc Đạt <56961917+datlechin@users.noreply.github.com> Co-authored-by: Kevin Østerkilde <kevin@oesterkilde.dk> Co-authored-by: Bagdasar Ovsepyan <66012777+b-ovsepian@users.noreply.github.com> Co-authored-by: Yoni Chechik <chechik.yoni@gmail.com> Co-authored-by: adventure-yunfei <adventure.yunfei@gmail.com> Co-authored-by: Morgane Dubus <30866152+mdubus@users.noreply.github.com>
2022-09-02 06:20:33 -04:00
- Read the [official documentation](https://docusaurus.io/)
- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups (#4490) * prepare v1-v2 domain switch * rename v1 changelog as CHANGELOG-1.x.md * switch v1/v2 changelogs * Cleanup v2.docusaurus.io urls * add netlify domain redirect * remove circleci config * remove another circle file
2021-03-22 15:57:49 -04:00
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
- Add a [search bar](https://docusaurus.io/docs/search)
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)