centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Remove mention of site_url being required option (#3525)

Browse Source
This commit is contained in:
Andre_601
2023-12-23 13:59:57 +01:00
committed by GitHub
parent b3f278ae73
commit 7186f4ce9c
1 changed files with 2 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/getting-started.md
View File

@@ -65,7 +65,6 @@ Now try editing the configuration file: `mkdocs.yml`. Change the
```yaml
site_name: MkLorum
site_url: https://example.com/
```
Your browser should immediately reload, and you'll see your new site name take
@@ -74,12 +73,8 @@ effect.
![The site_name setting](img/site-name.png)
NOTE:
The [`site_name`][site_name] and [`site_url`][site_url] configuration
options are the only two required options in your configuration file. When
you create a new project, the `site_url` option is assigned the placeholder
value: `https://example.com`. If the final location is known, you can change
the setting now to point to it. Or you may choose to leave it alone for now.
Just be sure to edit it before you deploy your site to a production server.
The [`site_name`][site_name] configuration
option is the only required option in your configuration file.
## Adding pages
@@ -96,7 +91,6 @@ setting:
```yaml
site_name: MkLorum
site_url: https://example.com/
nav:
- Home: index.md
- About: about.md
@@ -124,7 +118,6 @@ changing the theme. Edit the `mkdocs.yml` file and add a [`theme`][theme] settin
```yaml
site_name: MkLorum
site_url: https://example.com/
nav:
- Home: index.md
- About: about.md
@@ -216,6 +209,5 @@ To get help with MkDocs, please use the [GitHub discussions] or [GitHub issues].
[GitHub discussions]: https://github.com/mkdocs/mkdocs/discussions
[GitHub issues]: https://github.com/mkdocs/mkdocs/issues
[site_name]: user-guide/configuration.md#site_name
[site_url]: user-guide/configuration.md#site_url
[theme]: user-guide/configuration.md#theme
[User Guide]: user-guide/README.md