Skip to content

Commit 4f3c608

Browse files
yarlsonyarlson
committed
docs: enhance configuration guide with defaults and environment variables
1 parent f280ef0 commit 4f3c608

File tree

16 files changed

+662
-666
lines changed

16 files changed

+662
-666
lines changed

‎www/.vitepress/config.mts‎

Lines changed: 104 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,116 @@
11
import { defineConfig } from "vitepress";
22
import { withMermaid } from "vitepress-plugin-mermaid";
33

4-
export default withMermaid(defineConfig({
5-
title: "FTL Documentation",
6-
description: "Documentation for FTL - Faster Than Light Deployment Tool",
7-
srcDir: "./docs",
4+
export default withMermaid(
5+
defineConfig({
6+
title: "FTL Documentation",
7+
description: "Documentation for FTL - Faster Than Light Deployment Tool",
8+
srcDir: "./docs",
89

9-
markdown: {
10-
theme: {
11-
light: 'github-light',
12-
dark: 'github-dark'
10+
markdown: {
11+
theme: {
12+
light: "github-light",
13+
dark: "github-dark",
14+
},
15+
languages: ["yaml", "bash", "javascript", "json", "dockerfile"],
1316
},
14-
languages: ['yaml', 'bash', 'javascript', 'json', 'dockerfile']
15-
},
1617

17-
themeConfig: {
18-
nav: [
19-
{ text: "Home", link: "/" },
20-
{ text: "Getting Started", link: "/getting-started/" },
21-
{ text: "Core Tasks", link: "/core-tasks/" },
22-
{ text: "Configuration", link: "/configuration/" },
23-
{ text: "Guides", link: "/guides/" },
24-
{ text: "Reference", link: "/reference/" }
25-
],
26-
27-
sidebar: {
28-
"/": [
29-
{
30-
text: "Getting Started",
31-
collapsed: false,
32-
items: [
33-
{ text: "Introduction", link: "/getting-started/" },
34-
{ text: "Installation", link: "/getting-started/installation" },
35-
{ text: "Configuration", link: "/getting-started/configuration" },
36-
{
37-
text: "First Deployment",
38-
link: "/getting-started/first-deployment",
39-
},
40-
],
41-
},
42-
{
43-
text: "Core Tasks",
44-
collapsed: false,
45-
items: [
46-
{ text: "Overview", link: "/core-tasks/" },
47-
{ text: "Server Setup", link: "/core-tasks/server-setup" },
48-
{ text: "Building", link: "/core-tasks/building" },
49-
{ text: "Deployment", link: "/core-tasks/deployment" },
50-
{ text: "Logging", link: "/core-tasks/logging" },
51-
{ text: "Tunneling", link: "/core-tasks/tunneling" },
52-
],
53-
},
54-
{
55-
text: "Configuration",
56-
collapsed: true,
57-
items: [
58-
{ text: "Overview", link: "/configuration/" },
59-
{
60-
text: "Project Settings",
61-
link: "/configuration/project-settings",
62-
},
63-
{ text: "Services", link: "/configuration/services" },
64-
{ text: "Dependencies", link: "/configuration/dependencies" },
65-
{ text: "Volumes", link: "/configuration/volumes" },
66-
],
67-
},
68-
{
69-
text: "Guides",
70-
collapsed: true,
71-
items: [
72-
{ text: "Overview", link: "/guides/" },
73-
{ text: "Zero-downtime Deployment", link: "/guides/zero-downtime" },
74-
{ text: "Health Checks", link: "/guides/health-checks" },
75-
{ text: "SSL Management", link: "/guides/ssl-management" },
76-
],
77-
},
78-
{
79-
text: "Reference",
80-
collapsed: true,
81-
items: [
82-
{ text: "Overview", link: "/reference/" },
83-
{ text: "CLI Commands", link: "/reference/cli-commands" },
84-
{
85-
text: "Configuration File",
86-
link: "/reference/configuration-file",
87-
},
88-
{ text: "Environment Variables", link: "/reference/environment" },
89-
{ text: "Troubleshooting", link: "/reference/troubleshooting" },
90-
],
91-
},
18+
themeConfig: {
19+
nav: [
20+
{ text: "Home", link: "/" },
21+
{ text: "Getting Started", link: "/getting-started/" },
22+
{ text: "Core Tasks", link: "/core-tasks/" },
23+
{ text: "Configuration", link: "/configuration/" },
24+
{ text: "Guides", link: "/guides/" },
25+
{ text: "Reference", link: "/reference/" },
9226
],
93-
},
9427

95-
socialLinks: [{ icon: "github", link: "https://github.com/yarlson/ftl" }],
28+
sidebar: {
29+
"/": [
30+
{
31+
text: "Getting Started",
32+
collapsed: false,
33+
items: [
34+
{ text: "Introduction", link: "/getting-started/" },
35+
{ text: "Installation", link: "/getting-started/installation" },
36+
{ text: "Configuration", link: "/getting-started/configuration" },
37+
{
38+
text: "First Deployment",
39+
link: "/getting-started/first-deployment",
40+
},
41+
],
42+
},
43+
{
44+
text: "Core Tasks",
45+
collapsed: false,
46+
items: [
47+
{ text: "Overview", link: "/core-tasks/" },
48+
{ text: "Server Setup", link: "/core-tasks/server-setup" },
49+
{ text: "Building", link: "/core-tasks/building" },
50+
{ text: "Deployment", link: "/core-tasks/deployment" },
51+
{ text: "Logging", link: "/core-tasks/logging" },
52+
{ text: "Tunneling", link: "/core-tasks/tunneling" },
53+
],
54+
},
55+
{
56+
text: "Configuration",
57+
collapsed: true,
58+
items: [
59+
{ text: "Overview", link: "/configuration/" },
60+
{
61+
text: "Project Settings",
62+
link: "/configuration/project-settings",
63+
},
64+
{ text: "Services", link: "/configuration/services" },
65+
{ text: "Dependencies", link: "/configuration/dependencies" },
66+
{ text: "Volumes", link: "/configuration/volumes" },
67+
],
68+
},
69+
{
70+
text: "Guides",
71+
collapsed: true,
72+
items: [
73+
{ text: "Overview", link: "/guides/" },
74+
{
75+
text: "Zero-downtime Deployment",
76+
link: "/guides/zero-downtime",
77+
},
78+
{ text: "Health Checks", link: "/guides/health-checks" },
79+
{ text: "SSL Management", link: "/guides/ssl-management" },
80+
],
81+
},
82+
{
83+
text: "Reference",
84+
collapsed: true,
85+
items: [
86+
{ text: "Overview", link: "/reference/" },
87+
{ text: "CLI Commands", link: "/reference/cli-commands" },
88+
{
89+
text: "Configuration File",
90+
link: "/reference/configuration-file",
91+
},
92+
{ text: "Environment Variables", link: "/reference/environment" },
93+
{ text: "Troubleshooting", link: "/reference/troubleshooting" },
94+
],
95+
},
96+
],
97+
},
9698

97-
footer: {
98-
message: "Released under the MIT License.",
99-
copyright: "Copyright © 2024-present FTL Contributors",
100-
},
99+
socialLinks: [{ icon: "github", link: "https://github.com/yarlson/ftl" }],
101100

102-
search: {
103-
provider: "local",
104-
},
101+
footer: {
102+
message: "Released under the MIT License.",
103+
copyright: "Copyright © 2024-present FTL Contributors",
104+
},
105+
106+
search: {
107+
provider: "local",
108+
},
105109

106-
outline: {
107-
level: [2, 3],
108-
label: "On this page",
110+
outline: {
111+
level: [2, 3],
112+
label: "On this page",
113+
},
109114
},
110-
},
111-
}));
115+
}),
116+
);

‎www/.vitepress/theme/index.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
// https://vitepress.dev/guide/custom-theme
2-
import { h } from 'vue'
3-
import type { Theme } from 'vitepress'
4-
import DefaultTheme from 'vitepress/theme'
5-
import './vars.css'
6-
import './style.css'
2+
import { h } from "vue";
3+
import type { Theme } from "vitepress";
4+
import DefaultTheme from "vitepress/theme";
5+
import "./vars.css";
6+
import "./style.css";
77

88
export default {
99
extends: DefaultTheme,
1010
Layout: () => {
1111
return h(DefaultTheme.Layout, null, {
1212
// https://vitepress.dev/guide/extending-default-theme#layout-slots
13-
})
13+
});
1414
},
1515
enhanceApp({ app, router, siteData }) {
1616
// ...
17-
}
18-
} satisfies Theme
17+
},
18+
} satisfies Theme;

‎www/.vitepress/theme/style.css‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717
--vp-c-brand-soft: var(--flexoki-blue-100);
1818

1919
/* Buttons with improved contrast */
20-
--vp-button-brand-bg: var(--flexoki-blue-700); /* Darkened for better contrast on white */
20+
--vp-button-brand-bg: var(
21+
--flexoki-blue-700
22+
); /* Darkened for better contrast on white */
2123
--vp-button-brand-hover-bg: var(--flexoki-blue-800);
2224
--vp-button-brand-active-bg: var(--flexoki-blue-900);
2325

@@ -74,7 +76,7 @@
7476
--vp-c-bg-alt: var(--flexoki-850);
7577

7678
/* Adjusted text colors for better contrast */
77-
--vp-c-text-1: var(--flexoki-50); /* Lightened from 100 */
79+
--vp-c-text-1: var(--flexoki-50); /* Lightened from 100 */
7880
--vp-c-text-2: var(--flexoki-200); /* Lightened from 300 */
7981
--vp-c-text-3: var(--flexoki-300); /* Lightened from 400 */
8082

‎www/.vitepress/theme/vars.css‎

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,63 @@
11
:root {
22
/* Base colors */
3-
--flexoki-black: #100F0F;
4-
--flexoki-paper: #FFFCF0;
3+
--flexoki-black: #100f0f;
4+
--flexoki-paper: #fffcf0;
55

66
/* Base scale */
7-
--flexoki-50: #F2F0E5;
8-
--flexoki-100: #E6E4D9;
9-
--flexoki-150: #DAD8CE;
10-
--flexoki-200: #CECDC3;
11-
--flexoki-300: #B7B5AC;
12-
--flexoki-400: #9F9D96;
7+
--flexoki-50: #f2f0e5;
8+
--flexoki-100: #e6e4d9;
9+
--flexoki-150: #dad8ce;
10+
--flexoki-200: #cecdc3;
11+
--flexoki-300: #b7b5ac;
12+
--flexoki-400: #9f9d96;
1313
--flexoki-500: #878580;
14-
--flexoki-600: #6F6E69;
14+
--flexoki-600: #6f6e69;
1515
--flexoki-700: #575653;
16-
--flexoki-800: #403E3C;
16+
--flexoki-800: #403e3c;
1717
--flexoki-850: #343331;
1818
--flexoki-900: #282726;
19-
--flexoki-950: #1C1B1A;
19+
--flexoki-950: #1c1b1a;
2020

2121
/* Blue */
22-
--flexoki-blue-50: #E1ECEB;
23-
--flexoki-blue-100: #C6DDE8;
24-
--flexoki-blue-200: #92BFDB;
25-
--flexoki-blue-300: #66A0C8;
26-
--flexoki-blue-400: #4385BE;
27-
--flexoki-blue-500: #3171B2;
28-
--flexoki-blue-600: #205EA6;
29-
--flexoki-blue-700: #1A4F8C;
30-
--flexoki-blue-900: #12253B;
22+
--flexoki-blue-50: #e1eceb;
23+
--flexoki-blue-100: #c6dde8;
24+
--flexoki-blue-200: #92bfdb;
25+
--flexoki-blue-300: #66a0c8;
26+
--flexoki-blue-400: #4385be;
27+
--flexoki-blue-500: #3171b2;
28+
--flexoki-blue-600: #205ea6;
29+
--flexoki-blue-700: #1a4f8c;
30+
--flexoki-blue-900: #12253b;
3131

3232
/* Red */
33-
--flexoki-red-50: #FFE1D5;
34-
--flexoki-red-300: #E8705F;
35-
--flexoki-red-400: #D14D41;
36-
--flexoki-red-600: #AF3029;
33+
--flexoki-red-50: #ffe1d5;
34+
--flexoki-red-300: #e8705f;
35+
--flexoki-red-400: #d14d41;
36+
--flexoki-red-600: #af3029;
3737
--flexoki-red-700: #942822;
3838
--flexoki-red-950: #261312;
3939

4040
/* Green */
41-
--flexoki-green-50: #EDEECF;
42-
--flexoki-green-300: #A0AF54;
43-
--flexoki-green-400: #879A39;
44-
--flexoki-green-600: #66800B;
41+
--flexoki-green-50: #edeecf;
42+
--flexoki-green-300: #a0af54;
43+
--flexoki-green-400: #879a39;
44+
--flexoki-green-600: #66800b;
4545
--flexoki-green-700: #536907;
46-
--flexoki-green-950: #1A1E0C;
46+
--flexoki-green-950: #1a1e0c;
4747

4848
/* Yellow */
49-
--flexoki-yellow-50: #FAEEC6;
50-
--flexoki-yellow-300: #DFB431;
51-
--flexoki-yellow-400: #D0A215;
52-
--flexoki-yellow-600: #AD8301;
53-
--flexoki-yellow-700: #8E6B01;
54-
--flexoki-yellow-950: #241E08;
49+
--flexoki-yellow-50: #faeec6;
50+
--flexoki-yellow-300: #dfb431;
51+
--flexoki-yellow-400: #d0a215;
52+
--flexoki-yellow-600: #ad8301;
53+
--flexoki-yellow-700: #8e6b01;
54+
--flexoki-yellow-950: #241e08;
5555

5656
/* Magenta */
57-
--flexoki-magenta-50: #FEE4E5;
58-
--flexoki-magenta-300: #E47DA8;
59-
--flexoki-magenta-400: #CE5D97;
60-
--flexoki-magenta-600: #A02F6F;
61-
--flexoki-magenta-700: #87285E;
62-
--flexoki-magenta-950: #24131D;
57+
--flexoki-magenta-50: #fee4e5;
58+
--flexoki-magenta-300: #e47da8;
59+
--flexoki-magenta-400: #ce5d97;
60+
--flexoki-magenta-600: #a02f6f;
61+
--flexoki-magenta-700: #87285e;
62+
--flexoki-magenta-950: #24131d;
6363
}

0 commit comments

Comments
 (0)