ansible-nas/website
2022-09-20 23:00:57 +01:00
..
blog Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
docs Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
src Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
static Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
.gitignore Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
babel.config.js Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
docusaurus.config.js Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
package-lock.json Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
package.json Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
README.md Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01:00
sidebars.js Flip to Docusaurus 🐊 2022-09-20 23:00:57 +01: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.