Skip to content

Commit

Permalink
docs: enhance configuration guide with defaults and environment varia…
Browse files Browse the repository at this point in the history 
…bles
  • Loading branch information
@yarlson
yarlson committed Jan 19, 2025
1 parent f280ef0 commit 4f3c608
Show file tree
Hide file tree
Showing 16 changed files with 662 additions and 666 deletions.
203 changes: 104 additions & 99 deletions www/.vitepress/config.mts
View file
Original file line number Diff line number Diff line change
@@ -1,111 +1,116 @@
import { defineConfig } from "vitepress";
import { withMermaid } from "vitepress-plugin-mermaid";

export default withMermaid(defineConfig({
title: "FTL Documentation",
description: "Documentation for FTL - Faster Than Light Deployment Tool",
srcDir: "./docs",
export default withMermaid(
defineConfig({
title: "FTL Documentation",
description: "Documentation for FTL - Faster Than Light Deployment Tool",
srcDir: "./docs",

markdown: {
theme: {
light: 'github-light',
dark: 'github-dark'
markdown: {
theme: {
light: "github-light",
dark: "github-dark",
},
languages: ["yaml", "bash", "javascript", "json", "dockerfile"],
},
languages: ['yaml', 'bash', 'javascript', 'json', 'dockerfile']
},

themeConfig: {
nav: [
{ text: "Home", link: "/" },
{ text: "Getting Started", link: "/getting-started/" },
{ text: "Core Tasks", link: "/core-tasks/" },
{ text: "Configuration", link: "/configuration/" },
{ text: "Guides", link: "/guides/" },
{ text: "Reference", link: "/reference/" }
],

sidebar: {
"/": [
{
text: "Getting Started",
collapsed: false,
items: [
{ text: "Introduction", link: "/getting-started/" },
{ text: "Installation", link: "/getting-started/installation" },
{ text: "Configuration", link: "/getting-started/configuration" },
{
text: "First Deployment",
link: "/getting-started/first-deployment",
},
],
},
{
text: "Core Tasks",
collapsed: false,
items: [
{ text: "Overview", link: "/core-tasks/" },
{ text: "Server Setup", link: "/core-tasks/server-setup" },
{ text: "Building", link: "/core-tasks/building" },
{ text: "Deployment", link: "/core-tasks/deployment" },
{ text: "Logging", link: "/core-tasks/logging" },
{ text: "Tunneling", link: "/core-tasks/tunneling" },
],
},
{
text: "Configuration",
collapsed: true,
items: [
{ text: "Overview", link: "/configuration/" },
{
text: "Project Settings",
link: "/configuration/project-settings",
},
{ text: "Services", link: "/configuration/services" },
{ text: "Dependencies", link: "/configuration/dependencies" },
{ text: "Volumes", link: "/configuration/volumes" },
],
},
{
text: "Guides",
collapsed: true,
items: [
{ text: "Overview", link: "/guides/" },
{ text: "Zero-downtime Deployment", link: "/guides/zero-downtime" },
{ text: "Health Checks", link: "/guides/health-checks" },
{ text: "SSL Management", link: "/guides/ssl-management" },
],
},
{
text: "Reference",
collapsed: true,
items: [
{ text: "Overview", link: "/reference/" },
{ text: "CLI Commands", link: "/reference/cli-commands" },
{
text: "Configuration File",
link: "/reference/configuration-file",
},
{ text: "Environment Variables", link: "/reference/environment" },
{ text: "Troubleshooting", link: "/reference/troubleshooting" },
],
},
themeConfig: {
nav: [
{ text: "Home", link: "/" },
{ text: "Getting Started", link: "/getting-started/" },
{ text: "Core Tasks", link: "/core-tasks/" },
{ text: "Configuration", link: "/configuration/" },
{ text: "Guides", link: "/guides/" },
{ text: "Reference", link: "/reference/" },
],
},

socialLinks: [{ icon: "github", link: "https://github.com/yarlson/ftl" }],
sidebar: {
"/": [
{
text: "Getting Started",
collapsed: false,
items: [
{ text: "Introduction", link: "/getting-started/" },
{ text: "Installation", link: "/getting-started/installation" },
{ text: "Configuration", link: "/getting-started/configuration" },
{
text: "First Deployment",
link: "/getting-started/first-deployment",
},
],
},
{
text: "Core Tasks",
collapsed: false,
items: [
{ text: "Overview", link: "/core-tasks/" },
{ text: "Server Setup", link: "/core-tasks/server-setup" },
{ text: "Building", link: "/core-tasks/building" },
{ text: "Deployment", link: "/core-tasks/deployment" },
{ text: "Logging", link: "/core-tasks/logging" },
{ text: "Tunneling", link: "/core-tasks/tunneling" },
],
},
{
text: "Configuration",
collapsed: true,
items: [
{ text: "Overview", link: "/configuration/" },
{
text: "Project Settings",
link: "/configuration/project-settings",
},
{ text: "Services", link: "/configuration/services" },
{ text: "Dependencies", link: "/configuration/dependencies" },
{ text: "Volumes", link: "/configuration/volumes" },
],
},
{
text: "Guides",
collapsed: true,
items: [
{ text: "Overview", link: "/guides/" },
{
text: "Zero-downtime Deployment",
link: "/guides/zero-downtime",
},
{ text: "Health Checks", link: "/guides/health-checks" },
{ text: "SSL Management", link: "/guides/ssl-management" },
],
},
{
text: "Reference",
collapsed: true,
items: [
{ text: "Overview", link: "/reference/" },
{ text: "CLI Commands", link: "/reference/cli-commands" },
{
text: "Configuration File",
link: "/reference/configuration-file",
},
{ text: "Environment Variables", link: "/reference/environment" },
{ text: "Troubleshooting", link: "/reference/troubleshooting" },
],
},
],
},

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

search: {
provider: "local",
},
footer: {
message: "Released under the MIT License.",
copyright: "Copyright © 2024-present FTL Contributors",
},

search: {
provider: "local",
},

outline: {
level: [2, 3],
label: "On this page",
outline: {
level: [2, 3],
label: "On this page",
},
},
},
}));
}),
);
16 changes: 8 additions & 8 deletions www/.vitepress/theme/index.ts
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
import './vars.css'
import './style.css'
import { h } from "vue";
import type { Theme } from "vitepress";
import DefaultTheme from "vitepress/theme";
import "./vars.css";
import "./style.css";

export default {
extends: DefaultTheme,
Layout: () => {
return h(DefaultTheme.Layout, null, {
// https://vitepress.dev/guide/extending-default-theme#layout-slots
})
});
},
enhanceApp({ app, router, siteData }) {
// ...
}
} satisfies Theme
},
} satisfies Theme;
6 changes: 4 additions & 2 deletions www/.vitepress/theme/style.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
--vp-c-brand-soft: var(--flexoki-blue-100);

/* Buttons with improved contrast */
--vp-button-brand-bg: var(--flexoki-blue-700); /* Darkened for better contrast on white */
--vp-button-brand-bg: var(
--flexoki-blue-700
); /* Darkened for better contrast on white */
--vp-button-brand-hover-bg: var(--flexoki-blue-800);
--vp-button-brand-active-bg: var(--flexoki-blue-900);

Expand Down Expand Up @@ -74,7 +76,7 @@
--vp-c-bg-alt: var(--flexoki-850);

/* Adjusted text colors for better contrast */
--vp-c-text-1: var(--flexoki-50); /* Lightened from 100 */
--vp-c-text-1: var(--flexoki-50); /* Lightened from 100 */
--vp-c-text-2: var(--flexoki-200); /* Lightened from 300 */
--vp-c-text-3: var(--flexoki-300); /* Lightened from 400 */

Expand Down
82 changes: 41 additions & 41 deletions www/.vitepress/theme/vars.css
View file
Original file line number Diff line number Diff line change
@@ -1,63 +1,63 @@
:root {
/* Base colors */
--flexoki-black: #100F0F;
--flexoki-paper: #FFFCF0;
--flexoki-black: #100f0f;
--flexoki-paper: #fffcf0;

/* Base scale */
--flexoki-50: #F2F0E5;
--flexoki-100: #E6E4D9;
--flexoki-150: #DAD8CE;
--flexoki-200: #CECDC3;
--flexoki-300: #B7B5AC;
--flexoki-400: #9F9D96;
--flexoki-50: #f2f0e5;
--flexoki-100: #e6e4d9;
--flexoki-150: #dad8ce;
--flexoki-200: #cecdc3;
--flexoki-300: #b7b5ac;
--flexoki-400: #9f9d96;
--flexoki-500: #878580;
--flexoki-600: #6F6E69;
--flexoki-600: #6f6e69;
--flexoki-700: #575653;
--flexoki-800: #403E3C;
--flexoki-800: #403e3c;
--flexoki-850: #343331;
--flexoki-900: #282726;
--flexoki-950: #1C1B1A;
--flexoki-950: #1c1b1a;

/* Blue */
--flexoki-blue-50: #E1ECEB;
--flexoki-blue-100: #C6DDE8;
--flexoki-blue-200: #92BFDB;
--flexoki-blue-300: #66A0C8;
--flexoki-blue-400: #4385BE;
--flexoki-blue-500: #3171B2;
--flexoki-blue-600: #205EA6;
--flexoki-blue-700: #1A4F8C;
--flexoki-blue-900: #12253B;
--flexoki-blue-50: #e1eceb;
--flexoki-blue-100: #c6dde8;
--flexoki-blue-200: #92bfdb;
--flexoki-blue-300: #66a0c8;
--flexoki-blue-400: #4385be;
--flexoki-blue-500: #3171b2;
--flexoki-blue-600: #205ea6;
--flexoki-blue-700: #1a4f8c;
--flexoki-blue-900: #12253b;

/* Red */
--flexoki-red-50: #FFE1D5;
--flexoki-red-300: #E8705F;
--flexoki-red-400: #D14D41;
--flexoki-red-600: #AF3029;
--flexoki-red-50: #ffe1d5;
--flexoki-red-300: #e8705f;
--flexoki-red-400: #d14d41;
--flexoki-red-600: #af3029;
--flexoki-red-700: #942822;
--flexoki-red-950: #261312;

/* Green */
--flexoki-green-50: #EDEECF;
--flexoki-green-300: #A0AF54;
--flexoki-green-400: #879A39;
--flexoki-green-600: #66800B;
--flexoki-green-50: #edeecf;
--flexoki-green-300: #a0af54;
--flexoki-green-400: #879a39;
--flexoki-green-600: #66800b;
--flexoki-green-700: #536907;
--flexoki-green-950: #1A1E0C;
--flexoki-green-950: #1a1e0c;

/* Yellow */
--flexoki-yellow-50: #FAEEC6;
--flexoki-yellow-300: #DFB431;
--flexoki-yellow-400: #D0A215;
--flexoki-yellow-600: #AD8301;
--flexoki-yellow-700: #8E6B01;
--flexoki-yellow-950: #241E08;
--flexoki-yellow-50: #faeec6;
--flexoki-yellow-300: #dfb431;
--flexoki-yellow-400: #d0a215;
--flexoki-yellow-600: #ad8301;
--flexoki-yellow-700: #8e6b01;
--flexoki-yellow-950: #241e08;

/* Magenta */
--flexoki-magenta-50: #FEE4E5;
--flexoki-magenta-300: #E47DA8;
--flexoki-magenta-400: #CE5D97;
--flexoki-magenta-600: #A02F6F;
--flexoki-magenta-700: #87285E;
--flexoki-magenta-950: #24131D;
--flexoki-magenta-50: #fee4e5;
--flexoki-magenta-300: #e47da8;
--flexoki-magenta-400: #ce5d97;
--flexoki-magenta-600: #a02f6f;
--flexoki-magenta-700: #87285e;
--flexoki-magenta-950: #24131d;
}
Loading

0 comments on commit 4f3c608

Please sign in to comment.