docusaurus/website
Kayce Basques 284649c7c8
docs: clarify the usage of slug (#6926)
* Clarify the usage of slug

As a new user it was unclear whether setting `slug` would change the URL relative to the root directory or relative to the docs directory. The example I added should make that clear without needing to test out the functionality in a Docusaurus instance (which is what I had to do).

* editorial changes

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-17 07:54:18 +08:00
..
_dogfooding feat(core): allow plugin lifecycles to return relative paths (#6921) 2022-03-16 20:47:15 +08:00
blog docs: fix broken links (#6817) 2022-03-03 07:02:57 +08:00
community feat(website): new plugin to load CHANGELOG and render as blog (#6414) 2022-01-27 23:17:31 +08:00
docs docs: clarify the usage of slug (#6926) 2022-03-17 07:54:18 +08:00
src feat(core): allow plugin lifecycles to return relative paths (#6921) 2022-03-16 20:47:15 +08:00
static refactor: self-host KaTeX assets (#6429) 2022-01-27 11:39:45 +01:00
versioned_docs chore: upgrade dependencies (#6916) 2022-03-15 13:16:21 +08:00
versioned_sidebars chore: prepare v2.0.0-beta.17 release (#6829) 2022-03-03 18:44:41 +01:00
README.md feat(v2): disable optimization.removeAvailableModules for webpack performance (#1711) 2019-07-26 22:42:03 +07:00
babel.config.js chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00
delayCrowdin.mjs chore: clean up ESLint config, enable a few rules (#6514) 2022-01-31 10:31:24 +08:00
docusaurus.config-blog-only.js chore: upgrade docsearch-react to v3 stable, bump dependencies (#6752) 2022-02-24 19:39:32 +08:00
docusaurus.config.js feat(core): allow plugin lifecycles to return relative paths (#6921) 2022-03-16 20:47:15 +08:00
netlify.toml chore: upgrade netlify-cli (#6031) 2021-11-30 10:02:31 +08:00
package.json chore: upgrade dependencies (#6916) 2022-03-15 13:16:21 +08:00
sidebars.js feat(core): rework swizzle CLI (#6243) 2022-02-25 14:13:15 +01:00
sidebarsCommunity.js feat(website): new plugin to load CHANGELOG and render as blog (#6414) 2022-01-27 23:17:31 +08:00
testCSSOrder.mjs feat(core): rework swizzle CLI (#6243) 2022-02-25 14:13:15 +01:00
tsconfig.json chore(website): enable strict compiler option (#6012) 2021-11-26 18:14:35 +08:00
versions.json chore: prepare v2.0.0-beta.17 release (#6829) 2022-03-03 18:44:41 +01:00
versionsArchived.json chore: prepare v2.0.0-beta.17 release (#6829) 2022-03-03 18:44:41 +01:00
waitForCrowdin.mjs chore: clean up ESLint config, enable a few rules (#6514) 2022-01-31 10:31:24 +08: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.