strapi-plugin-config-sync/docs
Boaz Poolman c17ea4234c fix: docs deploy 2025-03-17 09:23:58 +01:00
..
.github/workflows chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
blog chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
docs chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
src chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
static chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
.gitignore chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
Dockerfile fix: docs deploy 2025-03-17 09:23:58 +01:00
README.md chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
babel.config.js chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
docusaurus.config.ts chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
package.json chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
sidebars.ts chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
tsconfig.json chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00
yarn.lock chore: move docs into the config-sync repo 2025-03-17 09:08:26 +01:00

README.md

Website

This website is built using Docusaurus, 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.