mirror of https://github.com/JakeHillion/object-introspection.git synced 2024-11-09 21:24:14 +00:00

History

Jay Kamat 4dbbbfc6cf Attempt to fix favicon		2023-09-05 20:01:42 +01:00
..
docs	Build with tests by default	2023-04-05 15:53:15 +01:00
src	Tweak social media previews for Oid website	2023-09-05 20:01:42 +01:00
static	Update favicon	2022-12-20 10:42:23 -08:00
.gitignore	Tweak social media previews for Oid website	2023-09-05 20:01:42 +01:00
babel.config.js	Initial commit	2022-12-19 06:37:51 -08:00
docusaurus.config.js	Attempt to fix favicon	2023-09-05 20:01:42 +01:00
package.json	Initial commit	2022-12-19 06:37:51 -08:00
README.md	Initial commit	2022-12-19 06:37:51 -08:00
sidebars.js	Initial commit	2022-12-19 06:37:51 -08:00
yarn.lock	Bump word-wrap from 1.2.3 to 1.2.5 in /website	2023-08-03 18:00:16 +01:00

README.md

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.

Continuous Integration

Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.

$ yarn ci