diff --git a/docusaurus-site/README.md b/docusaurus-site/README.md index e760857736e26189b22139089d2bd2db7df3a90c..80790d520f19e3b0aae3bfa907463e157d7720ec 100644 --- a/docusaurus-site/README.md +++ b/docusaurus-site/README.md @@ -6,21 +6,8 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta - [Node.js](https://nodejs.org/en/download/) version >= 14 or above OR [Yarn](https://yarnpkg.com/en/) version >= 1.5 ## Project Structure -/blog/ - Contains the blog Markdown files. More details can be found in the [blog guide](https://docusaurus.io/docs/blog) -/docs/ - Contains the Markdown files for the docs. Customize the order of the docs sidebar in sidebars.js. More details can be found in the [docs guide](https://docusaurus.io/docs/docs-markdown-features) - -/src/ - Non-documentation files like pages or custom React components. You don't have to strictly put your non-documentation files in here but putting them under a centralized directory makes it easier to specify in case you need to do some sort of linting/processing - -/src/pages - Any files within this directory will be converted into a website page. More details can be found in the [pages guide](https://docusaurus.io/docs/creating-pages) - -/static/ - Static directory. Any contents inside here will be copied into the root of the final build directory - -/docusaurus.config.js - A config file containing the site configuration. This is the equivalent of siteConfig.js in Docusaurus v1 - -/package.json - A Docusaurus website is a React app. You can install and use any npm packages you like in them - -/sidebar.js - Used by the documentation to specify the order of documents in the sidebar +See [Project structure](https://docusaurus.io/docs/installation#project-structure) ## Installation To install dependencies: