https://github.com/ceramicnetwork/docs-docusaurus
https://github.com/ceramicnetwork/docs-docusaurus
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ceramicnetwork/docs-docusaurus
- Owner: ceramicnetwork
- License: apache-2.0
- Created: 2023-10-18T13:20:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T15:50:37.000Z (over 1 year ago)
- Last Synced: 2025-01-20T23:06:58.537Z (over 1 year ago)
- Language: JavaScript
- Size: 24.7 MB
- Stars: 18
- Watchers: 5
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ceramic Documentation
This repository contains the code and markdown files for the Ceramic documentation site. View the full site at [**developers.ceramic.network**](https://developers.ceramic.network).
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Local Development
Follow these steps to run the site locally and test your changes.
Install the dependencies:
```
$ pnpm install
```
Start a local development server:
```
$ pnpm start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ pnpm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
The website is automatically deployed by a GitHub action on commits to the main branch.
## 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.