tree: 5b0a43e803d9e869615f65849071990a52d52d64 [path history] [tgz]
  1. docs/
  2. src/
  3. static/
  4. .gitignore
  5. babel.config.js
  6. docusaurus.config.js
  7. package.json
  8. README.md
  9. sidebars.js
doc/README.md

Apache Karaf Minho

Apache Karaf Minho website is built using Docusaurus 2.

Installation

$ yarn

NB: it's also possible to use npm instead of 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.