mycroforge/docs
2024-07-22 21:27:17 +02:00
..
.k8s Improved docs 2024-07-19 13:08:59 +02:00
docs Cleaned up, tested and documented --dbu-platform 2024-07-22 21:27:17 +02:00
src Improved docs 2024-07-19 13:08:59 +02:00
static - Refactored init & features 2024-07-14 22:27:32 +02:00
.dockerignore Optimised docs build and polished docs 2024-07-19 16:18:24 +02:00
.gitignore Added deployment capabilities 2024-07-17 23:20:07 +02:00
babel.config.js - Refactored init & features 2024-07-14 22:27:32 +02:00
Dockerfile Added deployment capabilities 2024-07-17 23:20:07 +02:00
docs.sln Added command plugin documentation and renamed subCommands to commands in api command code 2024-07-19 15:05:20 +02:00
docusaurus.config.ts Removed bash highlighting support 2024-07-20 00:33:02 +02:00
package-lock.json - Refactored init & features 2024-07-14 22:27:32 +02:00
package.json Added deployment capabilities 2024-07-17 23:20:07 +02:00
README.md Added deployment capabilities 2024-07-17 23:20:07 +02:00
requirements.txt - Refactored init & features 2024-07-14 22:27:32 +02:00
sidebars.ts - Refactored init & features 2024-07-14 22:27:32 +02:00
tsconfig.json - Refactored init & features 2024-07-14 22:27:32 +02:00

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.

Custom

kubectl --kubeconfig ~/.kube/main.k8s.config apply -f .k8s/remote.yml