diff --git a/README.md b/README.md index b22ecc811e279bffda43d81cd530b2c61c70f1d7..eedc9645440cb886fa5998b499c0d96ce3773d42 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ # xxdk dev docs +See [README](./docusaurus-site/README.md) \ No newline at end of file diff --git a/docusaurus-site/README.md b/docusaurus-site/README.md index aaba2fa1e16eebb0ff68df9127e1afc6395c74d8..e760857736e26189b22139089d2bd2db7df3a90c 100644 --- a/docusaurus-site/README.md +++ b/docusaurus-site/README.md @@ -1,30 +1,55 @@ -# Website +# xxDK Dev Docs This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. -### Installation +## Prerequisites +- [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 + +## Installation +To install dependencies: ``` -$ yarn +$ npm install +// or `yarn install` ``` -### Local Development +## Local Development ``` -$ yarn start +cd my-website +npm run start +# or `yarn run start` ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. -### Build +## Build ``` -$ yarn build +$ npm run build +# or `yarn run build` ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Deployment +## Deployment Using SSH: @@ -39,3 +64,7 @@ $ GIT_USER=<Your GitHub username> yarn deploy ``` If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. + +## Updating Docusaurus + +See [Updating your Docusaurus version](https://docusaurus.io/docs/installation#updating-your-docusaurus-version) \ No newline at end of file