https://github.com/azukaar/cosmos-docs
Documentation for Cosmos
https://github.com/azukaar/cosmos-docs
Last synced: 7 months ago
JSON representation
Documentation for Cosmos
- Host: GitHub
- URL: https://github.com/azukaar/cosmos-docs
- Owner: azukaar
- Created: 2023-11-05T12:02:24.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T16:18:38.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T15:35:52.055Z (9 months ago)
- Language: JavaScript
- Size: 6.47 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cosmos-Docs
This repository contains user documentation for cosmos cloud. Written in markdown and compiled into a static site using [Astro](https://astro.build/) and [Starlight](https://starlight.astro.build/)
The documentation itself can be found at .
## Installing
### Prerequisites
- **Node.js** - `v18.14.1` or higher.
- **pnpm**
- **Text editor** - We recommend either [VS Code](https://code.visualstudio.com/) with the [Official Astro extension](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode) or [IntelliJ IDEA](https://www.jetbrains.com/idea/) with the [Unofficial Astro Plugin](https://plugins.jetbrains.com/plugin/20959-astro)
- **Terminal** - The documentation is built and run through its command-line interface (CLI).
To get all the dependencies installed, run this command in the terminal:
- `npm install`
To build and run the docs locally, run this command in the terminal:
- `npm run dev`
Running both these commands in the terminal, will install the dependencies required for the docs and run a local environment on your machine.