65f87a7972
Bumps [@docusaurus/plugin-content-pages](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-plugin-content-pages) from 2.0.0-beta.15 to 2.0.0-beta.17. - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v2.0.0-beta.17/packages/docusaurus-plugin-content-pages) --- updated-dependencies: - dependency-name: "@docusaurus/plugin-content-pages" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> |
||
---|---|---|
.. | ||
components | ||
lib | ||
src | ||
static | ||
.gitignore | ||
docusaurus.config.js | ||
package-lock.json | ||
package.json | ||
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.