RandomSec/docs
Kush Trivedi b5bd5e62e4
feat: move to em from pixels (#3477)
* feat: move to em from pixels

Signed-off-by: Kush Trivedi <kushthedude@gmail.com>

* reduce the spacing b/w headings

Signed-off-by: Kush Trivedi <kushthedude@gmail.com>

* reduce spacing

Signed-off-by: Kush Trivedi <kushthedude@gmail.com>
2021-01-19 09:28:44 +01:00
..
docs Merge pull request #3380 from allanaaa/docs-formatting 2021-01-16 17:59:52 +00:00
src feat: move to em from pixels (#3477) 2021-01-19 09:28:44 +01:00
static Exporting 2021-01-12 15:19:24 -05:00
.gitignore begin Docusaurus 2 migration (#2799) 2020-06-29 08:45:24 +02:00
docusaurus.config.js Update to docusaurus-2.0.0-alpha.64 to fix security vuln in dependency (#3261) 2020-10-16 20:49:57 +02:00
package.json Bump react-dom from 16.13.1 to 16.14.0 in /docs (#3455) 2021-01-08 10:29:26 +01:00
README.md begin Docusaurus 2 migration (#2799) 2020-06-29 08:45:24 +02:00
sidebars.js Across-the-docs updates 2020-12-02 13:44:55 -05:00
yarn.lock Bump react-dom from 16.13.1 to 16.14.0 in /docs (#3455) 2021-01-08 10:29:26 +01:00

How to build these docs

We use Docusaurus 2 for our docs, a modern static website generator.

Requirements

Assuming you have Node.js installed (which includes npm), you can install Docusaurus with:

You will need to install Yarn before you can build the site.

npm install -g yarn

Installation

Once you have installed yarn, navigate to docs directory & set-up the dependencies.

cd docs
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

GIT_USER=<Your GitHub username> USE_SSH=true 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.