You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tutorials/using-bucket-website-with-mkdocs/index.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ This tutorial shows you how to create a documentation website using the Scaleway
18
18
[MkDocs](https://www.mkdocs.org/) is a static site generator that allows users to generate a static website from a set of Markdown files. It is written in Python and uses Markdown for content creation.
19
19
We will use MkDocs to generate our website, and Material for MkDocs which is a documentation framework that extends MkDocs with additional features and customization options, to create visually appealing and user-friendly documentation websites.
20
20
21
-
Find out how to Set up MkDocs and configure your website in the first tab, then click the second tab to learn how to get a preview of your website and how to deploy it.
21
+
Find out how to set up MkDocs and configure your website in the first tab, then click the second tab to learn how to get a preview of your website and deploy it.
22
22
23
23
<Macroid="requirements" />
24
24
@@ -58,7 +58,7 @@ Find out how to Set up MkDocs and configure your website in the first tab, then
58
58
mkdocs new .
59
59
```
60
60
<Messagetype="note">
61
-
This will create a YAML file named `mkdocs.yaml`, and a directory named `docs` containing an `index.md` file inside `my-folder`:
61
+
This will create a YML file named `mkdocs.yml`, and a directory named `docs` containing an `index.md` file inside `my-folder`:
62
62
- `docs` is the directory where you will need to create `.md` files containing your website's content.
63
63
- `index.md` is your website's homepage.
64
64
- `mkdocs.yml` is the file in which you can configure and customize your website.
@@ -121,7 +121,7 @@ Find out how to Set up MkDocs and configure your website in the first tab, then
121
121
122
122
You can use an accent color to emphasize elements such as buttons, scrollbars, and hovered links. Refer to the [MkDocs documentation](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#accent-color) for a list of available colors.
123
123
124
-
Copy and paste the following code template under `palette` to set your accent color to orange.
124
+
Copy and paste the following code template under `palette` to set your accent color to purple.
125
125
126
126
```
127
127
accent: purple
@@ -224,7 +224,7 @@ Find out how to Set up MkDocs and configure your website in the first tab, then
224
224
225
225
### Configuring navigation
226
226
227
-
MkDocs provides multiple ways to configure your website's navigation depending on the amount of content your website contains. Find out [all available configurations for navigation](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/) on the MkDocs website.
227
+
MkDocs provides multiple ways to configure your website's navigation depending on the amount of content your website contains. Find [all available configurations for navigation](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/) on the MkDocs website.
228
228
229
229
Set up the navigation structure of your website using the code sample below. This configuration allows you to organize your navigation menu as you wish.
230
230
@@ -336,7 +336,7 @@ Find out how to Set up MkDocs and configure your website in the first tab, then
336
336
337
337
If you have only added the elements shown in the sections above, you can download the `mkdcos.yml` below.
338
338
339
-
<ahref="/tutorials/using-bucket-website-with-mkdocs/mkdocs-example.yml"target="_blank"rel="noopener noreferrer"download="mkdocs-example.yml"> Download the mkdocs file </a>
339
+
<ahref="/tutorials/using-bucket-website-with-mkdocs/mkdocs-example.yml"target="_blank"rel="noopener noreferrer"download="mkdocs-example.yml"> Download the mkdocs.yml file </a>
340
340
341
341
</TabsTab>
342
342
<TabsTablabel="Preview and deploy your MkDocs website">
0 commit comments