Skip to content

Commit

Permalink
Added MKdocs minimal
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisgKent committed Jun 25, 2024
1 parent ce9a2f9 commit 2eb1a39
Show file tree
Hide file tree
Showing 5 changed files with 729 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ __pycache__
.ruff_cache
dist
outputs/
site/
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.
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
site_name: PrimalScheme3

site_url: https://chrisgkent.github.io/primalscheme3/
theme:
name: material
Loading

0 comments on commit 2eb1a39

Please sign in to comment.