https://github.com/xenitab/xenitab.github.io

Repository gathering documentation for Xenit open source projects
https://github.com/xenitab/xenitab.github.io

xenit-kubernetes-framework

Last synced: 29 days ago
JSON representation

Repository gathering documentation for Xenit open source projects

• Host: GitHub
• URL: https://github.com/xenitab/xenitab.github.io
• Owner: XenitAB
• License: mit
• Created: 2020-11-20T20:50:04.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-05T18:02:57.000Z (29 days ago)
• Last Synced: 2024-12-06T02:34:20.991Z (29 days ago)
• Topics: xenit-kubernetes-framework
• Language: JavaScript
• Homepage: https://xenitab.github.io/
• Size: 1.27 GB
• Stars: 7
• Watchers: 5
• Forks: 1
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Home

Welcome home!

## About

Repository gathering documentation for Xenit open source projects.

## More details

Take a look at the [Makefile](Makefile) and in [docs/](docs/).

## Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Installation

```console

yarn install

```

## Local Development

```console

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.

### Search function

The search function does not work when running the dev server, it requires running `yarn build` (see below).

## Build

```console

yarn build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service or locally by running `yarn serve`.

## Deployment

This documentation is deployed automatically to https://xenitab.github.io when changes are merged to the `main` branch.