Skip to content

Commit

Permalink
feat: ✨ scaffolding mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonyra committed Jan 12, 2024
1 parent 388a0d5 commit 0532755
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
37 changes: 37 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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: |
&copy; 2023 <a href="https://github.com/nerdnode-io/" target="_blank" rel="noopener">Nerdnode.io</a>

0 comments on commit 0532755

Please sign in to comment.