Skip to content
This repository has been archived by the owner on Jan 9, 2021. It is now read-only.

Latest commit

 

History

History
35 lines (22 loc) · 905 Bytes

README.md

File metadata and controls

35 lines (22 loc) · 905 Bytes

This repo no longer contains the maintained documentation of SwordCSS, checkout swordcss/swordcss-docs2 instead.

Website

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

Installation

yarn install

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