mirror of https://github.com/pure-css/pure.git synced 2024-11-07 21:34:24 +00:00

History

Seth Bertalotto 58a396be98 fix: spelling typo fixes #807		2020-07-01 12:45:59 -07:00
..
components	feat: add eslint (#801 )	2020-05-16 11:09:14 -07:00
lib	feat: add eslint (#801 )	2020-05-16 11:09:14 -07:00
src	fix: spelling typo fixes #807	2020-07-01 12:45:59 -07:00
static	feat: add eslint (#801 )	2020-05-16 11:09:14 -07:00
.gitignore	refactor: upgrade normalize, remove bower, remove old ie hacks (#790 )	2020-05-05 08:15:25 -07:00
docusaurus.config.js	feat: add eslint (#801 )	2020-05-16 11:09:14 -07:00
package-lock.json	feat: add eslint (#801 )	2020-05-16 11:09:14 -07:00
package.json	ci: move copy to deploy script	2020-05-16 11:13:24 -07:00
README.md	refactor: upgrade normalize, remove bower, remove old ie hacks (#790 )	2020-05-05 08:15:25 -07:00

README.md

Pure Documentation

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

Installation

$ npm install

Local Development

$ npm run 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

$ npm run 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 npm run deploy

The site is hosted on Vercel and will automatically deploy when commits are merged to master.

Including Pure

We want to use the locally built version of Pure so that the layout examples are always using the master version, previously they had used a hardcoded CDN link.

To get Docusaurus to register the css as static, they have to exist in the static/ directory before the site is built. Therefore, we copy the Pure build/ in manually and .gitignore them. Once Docusaurus builds, they resolve as proper CSS files.