Skip to content

rancherfederal/carbide-docs

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

cb0f56c · Oct 7, 2024
Aug 20, 2022
Oct 7, 2024
Feb 9, 2024
Jun 20, 2024
Aug 17, 2022
Feb 15, 2023
Feb 13, 2023
Feb 9, 2024
Jun 30, 2023
Aug 17, 2022
Mar 5, 2024
Apr 30, 2024
Apr 30, 2024
Jun 24, 2024

Repository files navigation

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

Contributing

  • Fork this repository
  • Make your changes
  • Commit changes and reference the Issue
  • Submit Pull Request with changes