https://github.com/ceramicnetwork/docs
Ceramic developer documentation site https://developers.ceramic.network
https://github.com/ceramicnetwork/docs
ceramic documentation
Last synced: 11 months ago
JSON representation
Ceramic developer documentation site https://developers.ceramic.network
- Host: GitHub
- URL: https://github.com/ceramicnetwork/docs
- Owner: ceramicnetwork
- Created: 2020-12-06T19:36:11.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T19:57:21.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T12:45:14.659Z (over 1 year ago)
- Topics: ceramic, documentation
- Language: HTML
- Homepage: https://developers.ceramic.network
- Size: 49.2 MB
- Stars: 22
- Watchers: 7
- Forks: 42
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ceramic Docs
This repo contains code and markdown files for the Ceramic documentation site. View the full site at [**developers.ceramic.network**](https://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](https://github.com/michaelsena)
- [Spencer T. Brody](https://github.com/stbrody)
- [Joel Thorstensson](https://github.com/oed)
## License
Fully open sourced under MIT and Apache 2.