|
2 | 2 | title: Introduction |
3 | 3 | slug: / |
4 | 4 | sidebar_position: 1 |
| 5 | +description: Explore our guides and examples to integrate Plane |
5 | 6 | --- |
6 | 7 |
|
7 | | -{frontMatter.description && <h3 class="description">{frontMatter.description}</h3>} |
8 | | - |
9 | | -# TODO Introduction |
10 | | - |
11 | | -TODO !!!!!! |
12 | | -Let's discover **Docusaurus in less than 5 minutes**. |
13 | | - |
14 | | -## Getting Started |
15 | | - |
16 | | -Get started by **creating a new site**. |
17 | | - |
18 | | -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. |
19 | | - |
20 | | -### What you'll need |
| 8 | +# Plane Developer Documentation |
21 | 9 |
|
22 | | -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: |
23 | | - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. |
24 | | - |
25 | | -## Generate a new site |
26 | | - |
27 | | -Generate a new Docusaurus site using the **classic template**. |
28 | | - |
29 | | -The classic template will automatically be added to your project after you run the command: |
30 | | - |
31 | | -```bash |
32 | | -npm init docusaurus@latest my-website classic |
33 | | -``` |
34 | | - |
35 | | -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. |
| 10 | +{frontMatter.description && <h3 class="description">{frontMatter.description}</h3>} |
36 | 11 |
|
37 | | -The command also installs all necessary dependencies you need to run Docusaurus. |
| 12 | +:::tip Let's Go! |
| 13 | +Get Started with Self-Hosting right away by visiting our [QuickStart](/self-hosting/overview). |
| 14 | +::: |
38 | 15 |
|
39 | | -## Start your site |
| 16 | +Greetings developer! 👋 |
40 | 17 |
|
41 | | -Run the development server: |
| 18 | +We're happy you're here. This site is focused on making it easy for you to |
| 19 | +integrate with Plane. Whether hosting Plane yourself or creating a custom |
| 20 | +integration, this is where you'll find all the fun details you need. 🦾 |
42 | 21 |
|
43 | | -```bash |
44 | | -cd my-website |
45 | | -npm run start |
46 | | -``` |
| 22 | +import { Card } from '@site/src/components/Card'; |
| 23 | +import { CardGroup } from '@site/src/components/CardGroup'; |
47 | 24 |
|
48 | | -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. |
| 25 | +## Solutions |
49 | 26 |
|
50 | | -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. |
| 27 | +<CardGroup cols={3}> |
| 28 | + <Card title="Self-Hosting" icon="FaDocker" href="/self-hosting/overview"> |
| 29 | + Learn how to self-host Plane. |
| 30 | + </Card> |
| 31 | + <Card title="API Reference" icon="FaCog" href="/api/the-plane-rest-api"> |
| 32 | + Use our API reference to build a custom integration. |
| 33 | + </Card> |
| 34 | + <Card title="Webhooks" icon="FaCog" href="/webhooks/intro"> |
| 35 | + Learn how to integrate Plane's webhooks with your service. |
| 36 | + </Card> |
| 37 | +</CardGroup> |
51 | 38 |
|
52 | | -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. |
0 commit comments