-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(book): use Vuepress for the book
- Loading branch information
Showing
122 changed files
with
518 additions
and
898 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[*.kt] | ||
ktlint_standard_filename = disabled |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
/book | ||
/theme | ||
/.vitepress/cache | ||
/.vitepress/dist | ||
/node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
import { defineConfig } from "vitepress"; | ||
import stefGrammar from "../../vscode-extension/syntaxes/stef.tmLanguage.json"; | ||
|
||
// https://vitepress.dev/reference/site-config | ||
export default defineConfig({ | ||
title: "Stef", | ||
description: "Strongly Typed Encoding Format", | ||
srcDir: "src", | ||
base: "/stef", | ||
markdown: { | ||
theme: { | ||
dark: "one-dark-pro", | ||
light: "min-light", | ||
}, | ||
languages: [ | ||
{ | ||
...stefGrammar, | ||
name: "stef", | ||
}, | ||
], | ||
lineNumbers: true, | ||
}, | ||
vite: { | ||
resolve: { | ||
preserveSymlinks: true, | ||
}, | ||
}, | ||
head: [["link", { rel: "icon", type: "image/svg+xml", href: "/logo.svg" }]], | ||
themeConfig: { | ||
// https://vitepress.dev/reference/default-theme-config | ||
logo: "/logo.svg", | ||
editLink: { | ||
pattern: "https://github.com/dnaka91/stef/edit/main/book/src/:path", | ||
}, | ||
nav: [ | ||
{ text: "Guide", link: "/guide/", activeMatch: "/guide/" }, | ||
{ text: "Reference", link: "/reference/", activeMatch: "/reference/" }, | ||
], | ||
|
||
sidebar: [ | ||
{ text: "Introduction", link: "/introduction" }, | ||
{ text: "Ideas", link: "/ideas" }, | ||
{ | ||
text: "User Guide", | ||
items: [ | ||
{ text: "Installation", link: "/guide/installation" }, | ||
{ text: "Creating schemas", link: "/guide/creating" }, | ||
{ text: "Generating code", link: "/guide/generating" }, | ||
{ text: "Examples", link: "/guide/examples" }, | ||
], | ||
}, | ||
{ | ||
text: "Reference", | ||
items: [ | ||
{ | ||
text: "Command Line Interface", | ||
link: "/reference/cli/", | ||
items: [ | ||
{ text: "stef lint", link: "/reference/cli/lint" }, | ||
{ text: "stef check", link: "/reference/cli/check" }, | ||
{ text: "stef format", link: "/reference/cli/format" }, | ||
], | ||
}, | ||
{ | ||
text: "Schema", | ||
link: "/reference/schema/", | ||
items: [ | ||
{ text: "Structs", link: "/reference/schema/structs" }, | ||
{ text: "Enums", link: "/reference/schema/enums" }, | ||
{ text: "Arrays", link: "/reference/schema/arrays" }, | ||
{ text: "Tuples", link: "/reference/schema/tuples" }, | ||
{ text: "Constants", link: "/reference/schema/constants" }, | ||
{ text: "Statics", link: "/reference/schema/statics" }, | ||
{ text: "Type Aliases", link: "/reference/schema/type-aliases" }, | ||
{ text: "Modules", link: "/reference/schema/modules" }, | ||
{ text: "Imports", link: "/reference/schema/imports" }, | ||
{ text: "References", link: "/reference/schema/references" }, | ||
{ text: "Attributes", link: "/reference/schema/attributes" }, | ||
], | ||
}, | ||
{ | ||
text: "Wire Format", | ||
link: "/reference/wire-format", | ||
}, | ||
{ | ||
text: "Compiler", | ||
link: "/reference/compiler", | ||
}, | ||
{ | ||
text: "Generators", | ||
link: "/reference/generators/", | ||
items: [ | ||
{ text: "Rust", link: "/reference/generators/rust" }, | ||
{ text: "Go", link: "/reference/generators/go" }, | ||
], | ||
}, | ||
], | ||
}, | ||
{ | ||
text: "Miscellaneous", | ||
items: [ | ||
{ text: "Team", link: "/misc/team" }, | ||
{ text: "License", link: "/misc/license" }, | ||
], | ||
}, | ||
], | ||
|
||
outline: "deep", | ||
|
||
socialLinks: [{ icon: "github", link: "https://github.com/dnaka91/stef" }], | ||
|
||
footer: { | ||
message: "Released under the MIT License.", | ||
copyright: "Copyright © 2023-present Dominik Nakamura", | ||
}, | ||
|
||
docFooter: { | ||
prev: false, | ||
next: false, | ||
}, | ||
|
||
search: { | ||
provider: "local", | ||
}, | ||
}, | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.