nodeguy/website
2019-12-08 21:30:33 +01:00
..
blog Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
docs update lineedit docs (#216) 2019-11-24 19:19:31 +01:00
src Updated the documentation with the links to talks 2019-11-06 21:42:56 +01:00
static Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
.gitignore Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
docusaurus.config.js Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
package.json Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
README.md Adds new doc site (#124) 2019-09-29 20:14:35 +02:00
sidebars.js Adds menubar, menu, systemtrayicon, shortcut and action docs 2019-10-26 22:21:17 +02:00
yarn.lock update yarn.lock for website 2019-12-08 21:30:33 +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 open 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=1 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.