Skip to content

Commit f771139

Browse files
nerda-codesRoRoJ
andauthored
docs(tuto): apply suggestions from code review
review bene & rowena Co-authored-by: Rowena Jones <[email protected]>
1 parent 897718a commit f771139

File tree

1 file changed

+5
-5
lines changed
  • tutorials/using-bucket-website-with-mkdocs

1 file changed

+5
-5
lines changed

tutorials/using-bucket-website-with-mkdocs/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This tutorial shows you how to create a documentation website using the Scaleway
1818
[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.
1919
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.
2020

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.
2222

2323
<Macro id="requirements" />
2424

@@ -58,7 +58,7 @@ Find out how to Set up MkDocs and configure your website in the first tab, then
5858
mkdocs new .
5959
```
6060
<Message type="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`:
6262
- `docs` is the directory where you will need to create `.md` files containing your website's content.
6363
- `index.md` is your website's homepage.
6464
- `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
121121

122122
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.
123123

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.
125125

126126
```
127127
accent: purple
@@ -224,7 +224,7 @@ Find out how to Set up MkDocs and configure your website in the first tab, then
224224

225225
### Configuring navigation
226226

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.
228228

229229
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.
230230

@@ -336,7 +336,7 @@ Find out how to Set up MkDocs and configure your website in the first tab, then
336336

337337
If you have only added the elements shown in the sections above, you can download the `mkdcos.yml` below.
338338

339-
<a href="/tutorials/using-bucket-website-with-mkdocs/mkdocs-example.yml" target="_blank" rel="noopener noreferrer" download="mkdocs-example.yml"> Download the mkdocs file </a>
339+
<a href="/tutorials/using-bucket-website-with-mkdocs/mkdocs-example.yml" target="_blank" rel="noopener noreferrer" download="mkdocs-example.yml"> Download the mkdocs.yml file </a>
340340

341341
</TabsTab>
342342
<TabsTab label="Preview and deploy your MkDocs website">

0 commit comments

Comments
 (0)