flo-bit.dev
[READ-ONLY] Mirror of https://github.com/flo-bit/dogumentation. Simple, minimalistic documentation template using astro
flo-bit.dev/dogumentation/
1.4 kB
59 lines
1---
2title: "Quick Start"
3description: "Learn how to install the template"
4order: 0
5---
6
7# Quick Start
8
9Quick start guide using github pages.
10
11## Fork the repo
12
13Fork the repo, naming it depending on where you want to it to show up.
14
15If you want to host it on `yourusername.github.io` then name the repo `yourusername.github.io`.
16
17Otherwise, name it something like `my-docs` and it will be hosted at `yourusername.github.io/my-docs`.
18
19Go to `/src/config.ts` and change the `SITE` and `BASE` variables.
20
21- `SITE` should be be `https://yourusername.github.io`.
22
23- `BASE` should either be empty if you named the repo `yourusername.github.io` or the name of the repo
24if you named it something else with a leading `/` (e.g. `/my-docs`).
25
26## Enable github pages
27
28Enable github pages in the repo settings. Go to *SETTINGS → PAGES → SOURCE: Github Actions*
29
30Your site should be live after a few minutes.
31
32## Development preview
33
341. Clone repo locally
35
36```bash
37git clone https://github.com/yourusername/yourrepo.git
38```
39
402. Install dependencies
41
42```bash
43npm install
44```
45
463. Start the development server
47
48```bash
49npm run dev
50```
51
524. Open the development preview at `http://localhost:4321/BASE`
53
54Changes made to the docs will be reflected live.
55
56### Next steps:
57
58- [Add some content](/dogumentation/docs/adding-content)
59- [Configure your template](/dogumentation/docs/configuration)