Skip to content

Commit 4a7cda0

Browse files
committed
Added some readme information.
1 parent 87290f6 commit 4a7cda0

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,28 @@ Results are published to [weeklydevchat.github.io](https://weeklydevchat.github.
77

88
![GitHub Pages](https://github.com/weeklydevchat/weeklydevchat.github.io/actions/workflows/ci.yml/badge.svg)
99
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)
10+
11+
12+
# Authors Guide
13+
14+
Requirements:
15+
- **Python** (any recent should be fine. Recommended to use a virtual environtment.)
16+
- **Material for MkDocs**
17+
18+
`pip install mkdocs-material`
19+
20+
[Material for MKDocs](https://squidfunk.github.io/mkdocs-material/) is a theme and plugin package for [MkDocs](https://www.mkdocs.org). Visit both sites for complete information.
21+
22+
23+
## Commands
24+
25+
* `mkdocs serve` - Start the live-reloading docs server. Use this to test changes locally before pushing.
26+
* `mkdocs -h` - Print help message and exit.
27+
28+
## Project layout
29+
30+
mkdocs.yml # The configuration file.
31+
docs/
32+
index.md # The documentation homepage.
33+
posts/ # blog posts, organised anyway you like
34+
... # Other markdown pages, images and other files.

mkdocs.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,2 @@
11
# Welcome to MkDocs
22

3-
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
4-
5-
## Commands
6-
7-
* `mkdocs new [dir-name]` - Create a new project.
8-
* `mkdocs serve` - Start the live-reloading docs server.
9-
* `mkdocs build` - Build the documentation site.
10-
* `mkdocs -h` - Print help message and exit.
11-
12-
## Project layout
13-
14-
mkdocs.yml # The configuration file.
15-
docs/
16-
index.md # The documentation homepage.
17-
... # Other markdown pages, images and other files.

0 commit comments

Comments
 (0)