mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-05-01 02:52:37 +02:00
feat: Add content
This commit is contained in:
@@ -1,13 +1,27 @@
|
||||
# About MkDocs
|
||||
|
||||
|
||||
## What is MkDocs?
|
||||
|
||||
MkDocs is a Python tool generates a static site based on content written in *markdown*.
|
||||
|
||||
If you are new to markdown, see the [Getting Started](https://www.markdownguide.org/getting-started/) page on the Markdown Guide website.
|
||||
|
||||
**Links:**
|
||||
|
||||
- [mkdocs.org](https://www.mkdocs.org) homepage
|
||||
- [mkdocs/mkdocs](https://github.com/mkdocs/mkdocs) on Github
|
||||
> "Project documentation with Markdown."
|
||||
- [MkDocs Wiki](https://github.com/mkdocs/mkdocs/wiki) on Github, covering themes, plugins, recipes and more.
|
||||
|
||||
|
||||
## Reasons to use MkDocs
|
||||
|
||||
- Create an elegant, modern docs site for your project.
|
||||
- Create a static site and serve from Github Pages easily.
|
||||
- Low-code solution
|
||||
- No need to write HTML or learn templating syntax needed
|
||||
- Use your existing markdown files as content
|
||||
- Use your existing markdown files as content.
|
||||
- Configure with a simple YAML file.
|
||||
- Customizable.
|
||||
- Add custom HTML if you want.
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
# Advanced configuration
|
||||
# Advanced
|
||||
> Beyond the basic configuration and content
|
||||
|
||||
Once you've got the [Setup Project](setup_project.md) section, you can customize further using this guide. Or skip this and go to [Usage](usage.md).
|
||||
|
||||
@@ -50,3 +51,13 @@ You can also structure your project to have the setup above nested inside a `doc
|
||||
|
||||
|
||||
An example of this is the [Poetry](https://github.com/python-poetry/poetry/tree/master/docs) repo. That project is also how I got into MkDocs in the first place.
|
||||
|
||||
## Embedding
|
||||
|
||||
To embed a gist, just copy and paste the embed script URL which is provided on a gist.
|
||||
|
||||
e.g.
|
||||
|
||||
```html
|
||||
<script src="https://gist.github.com/MichaelCurrin/57caae30bd7b0991098e9804a9494c23.js"></script>
|
||||
```
|
||||
|
||||
@@ -10,7 +10,6 @@ Use one of the approaches below:
|
||||
|
||||
- Create a quickstart project with the `new` command covered in [Create a starter site](#create-a-starter-site).
|
||||
- Follow the extended guide to create a [Setup up docs site](#setup-a-docs-site) by hand.
|
||||
- Click *Use this Template* button on the Github repo to get your own copy.
|
||||
|
||||
|
||||
### Basic structure
|
||||
|
||||
Reference in New Issue
Block a user