docusaurus/website
Sébastien Lorber db79d462ab
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 16:20:11 +02:00
..
community feat(v2): auto-generated sidebars, frontmatter-less sites (#4582) 2021-04-15 16:20:11 +02:00
docs feat(v2): auto-generated sidebars, frontmatter-less sites (#4582) 2021-04-15 16:20:11 +02:00
dogfooding fix(v2): BaseUrl issue banner insertion should be prevented if JS can load (#4155) 2021-02-02 16:43:25 +01:00
src docs(v2): add Kubevela showcase (#4616) 2021-04-15 16:03:04 +02:00
static chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups (#4490) 2021-03-22 20:57:49 +01:00
versioned_docs docs(v2): add clarity to tip in versioned using-themes page (#4609) 2021-04-13 19:59:50 +02:00
versioned_sidebars chore(v2): remove docs for alpha v70 (#4457) 2021-03-18 18:36:58 +03:00
babel.config.js feat(v2): Allow configuring babel via babel.config.js (#2903) 2020-06-12 11:03:00 +08:00
docusaurus.config-blog-only.js chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups (#4490) 2021-03-22 20:57:49 +01:00
docusaurus.config.js docs(v2): i18n site: enable ko + zh-CN locales (#4599) 2021-04-11 19:21:13 +02:00
netlify.toml chore: simplify CI setup (#4447) 2021-03-18 17:40:28 +01:00
package.json chore: simplify CI setup (#4447) 2021-03-18 17:40:28 +01:00
README.md feat(v2): disable optimization.removeAvailableModules for webpack performance (#1711) 2019-07-26 22:42:03 +07:00
sidebars.js feat(v2): provide doc sidebar_label through sidebars.js (#4500) 2021-03-26 15:11:21 +01:00
sidebarsCommunity.js feat(v2): auto-generated sidebars, frontmatter-less sites (#4582) 2021-04-15 16:20:11 +02:00
tsconfig.json docs(v2): Document TypeScript support (#2997) 2020-06-26 12:09:21 +02:00
versions.json chore: json files should be linted (#4462) 2021-03-18 19:39:50 +01:00

Docusaurus 2 Website

Installation

  1. yarn install in the root of the repo (one level above this directory).
  2. In this directory, do yarn start.
  3. A browser window will open up, pointing to the docs.