8000 kro/website at main · dominik-lekse/kro · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
 
 

website

README.md

Website

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

Installation

If you're using other tools than npm, you can refer to the docusaurs documentation for build and installation https://docusaurus.io/docs/installation#build

If you are using yarn, use:

$ yarn

Local Development

< 40EC /a>

To start a local development server, use:

$ 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.

To generate static content for deployment, use:

$ 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.

Versioning

When a new kro controller version is released, you should also update/release the documentation:

  1. Create a Docusaurus version
    Remove the v prefix from your version (e.g., v0.1.0 → 0.1.0):

    version_number=${version#v}
    npm run docusaurus docs:version $version_number
  2. Submit a Pull Request
    Commit your changes and open a PR to publish the new versioned docs.

0