https://github.com/cosmicjs/cosmic-docs
Cosmic API v2 docs
https://github.com/cosmicjs/cosmic-docs
api cosmicjs headless-cms
Last synced: 11 months ago
JSON representation
Cosmic API v2 docs
- Host: GitHub
- URL: https://github.com/cosmicjs/cosmic-docs
- Owner: cosmicjs
- License: mit
- Created: 2021-01-06T18:02:52.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-05-25T18:00:37.000Z (about 3 years ago)
- Last Synced: 2025-04-05T05:11:26.150Z (about 1 year ago)
- Topics: api, cosmicjs, headless-cms
- Language: JavaScript
- Homepage: https://docs-v2.cosmicjs.com
- Size: 1.2 MB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IMPORTANT
This is the codebase for the Cosmic API v2 docs. For the latest docs, go to https://www.cosmicjs.com/docs.
# Cosmic Docs API v2
This is the codebase for the [Cosmic docs v2](https://docs-v2.cosmicjs.com/).
## Development
### Installation
The Nextra repository uses [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces). To install dependencies, just simply run `yarn` in the project root directory.
### Build Nextra Theme
```
cd packages/nextra-theme-docs
yarn build
```
Watch mode: `yarn dev`
Watch mode (layout only): `yarn dev:layout`
Watch mode (style only): `yarn dev:tailwind`
### Development
To start Cosmic Docs locally, run
```
cd cosmic-docs
yarn dev
```
Any change to cosmic-docs will be re-rendered instantly.
If you update the core or theme packages, a rebuild is required. Or you can use the watch mode for both nextra and the theme in separated terminals.