flo-bit.dev
[READ-ONLY] Mirror of https://github.com/flo-bit/dogumentation. Simple, minimalistic documentation template using astro
flo-bit.dev/dogumentation/
2.2 kB
85 lines
1---
2title: "Configuration"
3description: "Configure your documentation"
4---
5
6# Configuration
7
8There are some configuration options that can be set in the `src/config.ts` file.
9
10Most importantly you **have** to set the `SITE` and `BASE` variables for deployment
11(see [Quick Start](/dogumentation/docs/quick-start) for more information).
12
13## Basics
14
15Set your site name, description and favicon.
16
17```ts
18const config = {
19 //...
20
21 SITE_NAME: "Dogumentation",
22 SITE_DESCRIPTION: "Simple, minimalistic documentation template using astro",
23 SITE_FAVICON: "🐶"
24
25 // ...
26}
27```
28
29## Colors
30
31Set the base and accent colors for your site.
32
33Base colors can be `zinc`, `slate`, `neutral`, `stone`, `gray`.
34
35Accent colors can be `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`.
36
37```ts
38const config = {
39 //...
40
41 BASE_COLOR: "zinc",
42 ACCENT_COLOR: "cyan"
43
44 // ...
45}
46```
47
48## Social Links
49
50Set the social links for your site.
51
52```ts
53const config = {
54 //...
55
56 SOCIAL_LINKS: {
57 FACEBOOK_URL: "https://facebook.com/your-page",
58 TWITTER_URL: "https://twitter.com/your-page",
59 GITHUB_URL: "https://github.com/your-page",
60 LINKEDIN_URL: "https://linkedin.com/in/your-page",
61 YOUTUBE_URL: "https://youtube.com/your-page",
62 BLUESKY_URL: "https://bluesky.com/your-page",
63 DISCORD_URL: "https://discord.com/your-page",
64 EMAIL: "your-email@example.com"
65 }
66}
67```
68
69Any of the links can be omitted if you don't have a page for that social link.
70
71All included social links will be shown in the header and footer of your site like this:
72
73import SocialIcons from "$components/SocialIcons.astro";
74
75<div class="flex items-center justify-end gap-x-4 p-4 bg-base-100 dark:bg-base-900/50 border border-base-200 dark:border-base-800 rounded-2xl">
76 <SocialIcons />
77</div>
78
79## Start page
80
81The start page will show a button to the first doc in your `src/content/docs` folder (= the first one in the sidebar).
82
83It will also show your site name and description and a screenshot of your app.
84
85Set the screenshot by replacing `src/assets/screen-light.png` and `src/assets/screen-dark.png` with your own images.