Skip to content
Open
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
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ doc: ## Generates & checks documentation

.PHONY: book
book: ## Builds the book & serves documentation site
mdbook serve --open docs
cd docs && npm install && npm run start:dev

# --- testing -------------------------------------------------------------------------------------

Expand Down
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.docusaurus/
build/
node_modules/
1 change: 1 addition & 0 deletions docs/.node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
22
63 changes: 63 additions & 0 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import type { Config } from "@docusaurus/types";
import { themes as prismThemes } from "prism-react-renderer";

const DOCS_PATH =
process.env.DOCS_PATH || (require("fs").existsSync("src") ? "src" : ".");

const config: Config = {
title: "Docs Dev Preview",
url: "http://localhost:3001",
baseUrl: "/",
trailingSlash: false,

presets: [
[
"classic",
{
docs: {
path: DOCS_PATH,
routeBasePath: "/",
sidebarPath: "./sidebars.ts",
remarkPlugins: [require("remark-math")],
rehypePlugins: [require("rehype-katex")],
versions: {
current: {
label: `unstable`,
},
},
},
blog: false,
pages: false,
theme: {
customCss: "./styles.css",
},
},
],
],

plugins: [
[
"@cmfcmf/docusaurus-search-local",
{
indexDocs: true,
indexBlog: false,
indexPages: false,
language: "en",
style: undefined,
},
],
],

themeConfig: {
navbar: {
title: "Note Transport Layer",
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
additionalLanguages: ["protobuf", "toml", "bash", "rust"],
},
},
};

export default config;
Loading
Loading