Skip to content

mudlers/cos-toolkit-docs

 
 

Repository files navigation

cos-toolkit-docs

This repository holds the cos-toolkit docs.

The master branch holds the sources that are compiled with Hugo.

The website content it is deployed automatically in the gh-pages branch by Github Actions, and no manual intevention is needed.

Test your changes

After cloning the repo (with submodules), just run make serve to test the website locally.

$> git clone --recurse-submodule https://github.com/rancher-sandbox/cos-toolkit-docs
$> cd cos-toolkit-docs
$> make serve

Or just sync the submodules:

$> git submodule update --init --recursive --depth 1

To run the website locally in other platforms, e.g. MacOS:

$> HUGO_PLATFORM=macOS-64bit make serve

About

Documentation for https://github.com/rancher-sandbox/cOS-toolkit

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • HTML 83.9%
  • JavaScript 8.7%
  • SCSS 6.3%
  • Other 1.1%