Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
node_modules
.vitepress/cache
.vitepress/dist
.idea
.idea
.vscode
28 changes: 13 additions & 15 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,20 @@ import {defineConfig} from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Railroad Docs",
description: "The documentation for the Railroad IDE",
locales: {
description: "Documentation for the Railroad IDE",
locales: { // IMPORTANT : L10n is not yet implemented
root: {
label: 'English',
lang: 'en'
},
fr: {
label: 'Français', //TODO create a system to "patch" the docs to other languages
lang: 'fr',
link: '/fr/'
}
},
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
//TODO add edit links?
i18nRouting: true,
i18nRouting: false,
editLink: {
pattern: 'https://github.com/Railroad-Team/RailroadDocs/edit/main/src/:path'
},
logo: "/railroad.png",
nav: [
{text: 'Home', link: '/'},
{text: 'Tutorials', link: '/tutorials/getting-started'},
Expand All @@ -40,6 +38,7 @@ export default defineConfig({
{text: 'Introduction', link: '/plugins/'},
{
text: 'Guide',
collapsed: true,
items: [
{text: 'Getting Started', link: '/plugins/guide/getting-started'},
{text: 'Project Setup', link: '/plugins/guide/project-setup'},
Expand All @@ -54,6 +53,7 @@ export default defineConfig({
},
{
text: 'API Reference',
collapsed: true,
items: [
{text: 'Introduction', link: '/plugins/api-reference/'},
{text: 'Plugin', link: '/plugins/api-reference/plugin'},
Expand All @@ -66,6 +66,7 @@ export default defineConfig({
{text: 'Logger', link: '/plugins/api-reference/logger.md'},
{
text: 'UI Components',
collapsed: true,
link: '/plugins/api-reference/ui/',
items: [
{text: 'RRButton', link: '/plugins/api-reference/ui/rr-button'},
Expand All @@ -87,6 +88,7 @@ export default defineConfig({
{text: 'Localized Components', link: '/plugins/api-reference/ui/localized-components'},
{
text: 'Forms', link: '/plugins/api-reference/ui/forms/index.md',
collapsed: true,
items: [
{text: 'FormCheckBox', link: '/plugins/api-reference/ui/forms/form-check-box'},
{text: 'FormComboBox', link: '/plugins/api-reference/ui/forms/form-combo-box'},
Expand All @@ -107,19 +109,15 @@ export default defineConfig({
]
}
]
},
{
text: 'Porting from other platforms',
link: '/port/'
}
],

socialLinks: [
{icon: 'github', link: 'https://github.com/Railroad-Team/Railroad'}
{icon: 'github', link: 'https://github.com/Railroad-Team/'},
{icon: 'discord', link: 'https://discord.turtywurty.dev/'}
],
},
srcDir: 'src',
ignoreDeadLinks: true, // TEMPORARY: Remove at a later date
markdown: {
theme: {
light: "catppuccin-latte",
Expand Down
21 changes: 21 additions & 0 deletions .vitepress/theme/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/* Light Mode */

:root {
--vp-button-alt-bg: #e3e6ed;
}

.VPNavBar {
border-bottom: 2px solid #d2d5dc;
background-color: #e6e9ef;
}

/* Dark Mode */

.dark {
--vp-button-alt-bg: #353552; /* Make front page secondary button background not blend in with background*/
}

.dark .VPNavBar {
border-bottom: 2px solid #353552; /* Border for navbar */
background-color: #26263a; /* Distinguish between nav bar and main page content */
}
1 change: 1 addition & 0 deletions .vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DefaultTheme from "vitepress/theme";
import "@catppuccin/vitepress/theme/mocha/sapphire.css";
import "./custom.css"

export default DefaultTheme;
Loading