Ceramic Docs

This repo contains code and markdown files for the Ceramic documentation site. View the full site at developers.ceramic.network.

Contributing

We welcome all contributions – big and small. To contribute, make your change and submit a PR to this repo describing what you've done.

Installation

Follow these steps to run the site locally and test your changes if they're substantial.

Install pip

sudo apt-get install pip3

Mac with Python3 and Homebrew

brew install python3

Install mkdocs and related dependencies

pip3 install mkdocs mkdocs-material mkdocs-redirects

Build and run the docs server

mkdocs serve

Webserver with built docs should now be running and can be connected to in a browser at localhost:8000

Maintainers

• Michael Sena
• Spencer T. Brody
• Joel Thorstensson

License

Fully open sourced under MIT and Apache 2.