carbide-docs's Introduction

Rancher Government Carbide Docs

               ,        ,  _______________________________
   ,-----------|'------'|  |                             |
  /.           '-'    |-'  |_____________________________|
 |/|             |    |
   |   .________.'----'    _______________________________
   |  ||        |  ||      |                             |
   \__|'        \__|'      |_____________________________|

|‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾|
|________________________________________________________|

|‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾|
|________________________________________________________|

Local Development

Installing Dependencies (docusaurus)

git clone https://github.com/rancherfederal/carbide-docs
cd carbide-docs

# install docusaurus & dependencies from package.json
npm install # make sure you are in the root of the dir containing `package.json`
# yarn install # if npm install did not work

# test the installation
npx docusaurus --version

Deploy Locally

npm run start # this will open your default browser to http://localhost:3000

Creating Content

Official Docusaurus Documentation

Publishing Content

This docs site is served using github-pages. There is an action that will trigger upon commit to the main branch and deploy the new build to https://rancherfederal.github.io/carbide-docs/.