kubagdynia / kadena-docs

Documentation and announcements for miners on the Kadena Public Blockchain

Kadena Docs

This project contains the old documentation used to support the old Kadena Docs resource site.

The new documentation site is at https://docs.kadena.io/, and it will be open sourced soon.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installing

clone the repository

Contributing

To make updates to this site you need to complete the following steps.

git add .
git commit -m 'short description of changes goes here'
git push -u origin master

To preview changes, run the following command:

mkdocs serve

And navigate to http://127.0.0.1:8000 on your browser.

Publishing

Deploy these changes to the live site (AVOID until going live)

mkdocs gh-deploy --clean

Using Docker

You can also serve, build, and deploy with the mkdocs-material docker container as described here:

https://hub.docker.com/r/squidfunk/mkdocs-material/

The following single command should deploy an updated site:

docker run --rm -it -v ~/.ssh:/root/.ssh -v ${PWD}:/docs squidfunk/mkdocs-material gh-deploy 

Built With

• MkDocs
• Material for MkDocs
• GitHub Pages