https://github.com/makeplane/docs
The official https://docs.plane.so documentation 📝
https://github.com/makeplane/docs
docs jira-alternative nextjs plane
Last synced: 6 months ago
JSON representation
The official https://docs.plane.so documentation 📝
- Host: GitHub
- URL: https://github.com/makeplane/docs
- Owner: makeplane
- Created: 2023-03-06T13:45:59.000Z (over 2 years ago)
- Default Branch: preview
- Last Pushed: 2024-12-12T15:19:44.000Z (6 months ago)
- Last Synced: 2024-12-12T16:25:30.456Z (6 months ago)
- Topics: docs, jira-alternative, nextjs, plane
- Language: CSS
- Homepage: https://docs.plane.so/
- Size: 154 MB
- Stars: 25
- Watchers: 5
- Forks: 33
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Plane Documentation
This website is built using [Docusaurus v3](https://docusaurus.io/) and hosted at [docs.plane.so](https://docs.plane.so/). If you are looking for the developer documentation, see [Plane developer documentation](https://github.com/makeplane/developer-docs).
## Overview
The Plane documentation provides detailed information on the following topics:
- Understanding the different components of Plane.
- Establishing connections between Plane and other applications.
## Installation
1. Clone the repository.
```bash
git clone [email protected]:makeplane/docs.git
```
2. Navigate to the project directory.
```bash
cd docs
```
3. Install dependencies.
```bash
yarn
```
## Local development
```bash
yarn 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
```bash
yarn build
```
This command generates static files into the `build` directory.
## Contributing
Interested in helping us improve the documentation? We’d love your contributions! Whether you're fixing a typo, adding a new guide, or improving an existing page, every bit helps.
To get started, check out our [Contribution Guide](/CONTRIBUTING.md). We welcome contributions related to core product features or integrations with other tools.