To see the contents of the docs, please navigeate to https://docs.shieldoo.io/.
The site is based on Jekyll template.
To run the site locally, follow the github instruction.
NOTE Please keep in mind that the site is rooted in the /docs/
folder of the repo.
- Clone the repository to your local machine
git clone [email protected]:cloudfieldcz/shieldoo-mesh-docs.git
. - Navigate to the root directory of the cloned repository
cd shieldoo-mesh-docs/docs
/ - Install the required gems by running the following command:
bundle install
. - Start the Jekyll server by running the following command:
bundle exec jekyll serve
.
Open your web browser and go to http://localhost:4000/ to view the site.
The site is hosted on github pages and is deployed automatically from the main
branch using a github action.