Skip to content

Commit

Permalink
docs: add auto-generated mkdocs files
Browse files Browse the repository at this point in the history
Add the auto-generated MkDocs files, created by running `mkdocs new
git-template`, to this repository.
  • Loading branch information
ShahradR authored Oct 21, 2022
1 parent 88a6b84 commit 293c3ea
Show file tree
Hide file tree
Showing 2 changed files with 18 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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site_name: git-template

0 comments on commit 293c3ea

Please sign in to comment.