docusaurus/packages/create-docusaurus/templates/shared
Sam Gutentag aa5c9f5064
docs: make tutorial code block directly copyable (#6833)
* code block included diff +,- 

Sample code block could not be copy/pasted as the tutorial mentions with the lines that appear to be from a diff tool.

* add highlight

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-04 09:04:02 +08:00
..
blog feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
docs docs: make tutorial code block directly copyable (#6833) 2022-03-04 09:04:02 +08:00
src/pages feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
static fix(create): update broken SVG paths in templates (#6762) 2022-02-27 07:44:50 +08:00
babel.config.js feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
gitignore feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
README.md feat: allow GIT_USER env var to be unset if SSH is used (#5840) 2021-11-10 18:51:12 +08:00
sidebars.js refactor(content-docs): refactor sidebars, Joi validation, generator rework, expose config types (#5678) 2021-10-14 14:38:26 +02:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn 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

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ 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.