Skip to content

StarlaneStudios/cirql-docs

Repository files navigation

Cirql documentation

This repository houses the documentation website source for Cirql, powered by Docusaurus 2.

Getting started

Installation

$ pnpm install

Local Development

$ 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.

Contributing

Maintaining documentation is hard, especially for a small team like ours. Contributions to our documentation are always welcome. If you see something that could be improved, please open an issue or submit a pull request.

This repository follows the same Contributor Guide as the main repository.

Requirements

  • PNPM (npm i -g pnpm)

Copyright (c) 2024, Starlane Studios

About

Documentation repository for Cirql

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published