From 05327553e502901fdb363413e2bdd3ce4b48be13 Mon Sep 17 00:00:00 2001 From: Anthony Anderson Date: Fri, 12 Jan 2024 18:08:22 -0500 Subject: [PATCH] feat: :sparkles: scaffolding mkdocs --- docs/index.md | 17 +++++++++++++++++ mkdocs.yml | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..a28c9d3 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,37 @@ +site_name: Nerdnode +theme: + name: material + features: + - navigation.tabs + - navigation.sections + - toc.integrate + - navigation.top + - search.suggest + - search.highlight + - content.tabs.link + - content.code.annotation + - content.code.copy + language: en + palette: + - scheme: default + toggle: + icon: material/toggle-switch-off-outline + name: Switch to dark mode + primary: teal + accent: purple + - scheme: slate + toggle: + icon: material/toggle-switch + name: Switch to light mode + primary: teal + accent: lime + +extra: + social: + - icon: fontawesome/brands/github-alt + link: https://github.com/nerdnode-io/ + - icon: fontawesome/brands/discord + link: https://discord.gg/vthGREn5 + +copyright: | + © 2023 Nerdnode.io \ No newline at end of file