JakeHillion/object-introspection
1
0
Fork 0
mirror of https://github.com/JakeHillion/object-introspection.git synced 2024-12-22 05:23:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
pr515
object-introspection/website
History
Thierry Treyer d27fbb4c0e Upgrade to Docusaurus v3
2024-09-19 16:26: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 Use objectintrospection.org for the website 2023-09-21 20:59:46 +01: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 add cppcon presentation links (#478) 2024-02-06 12:54:59 +00:00
package.json Upgrade to Docusaurus v3 2024-09-19 16:26:42 +01: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 Upgrade to Docusaurus v3 2024-09-19 16:26:42 +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