Skip to content

Commit 897718a

Browse files
committed
docs(tuto): last fixes
1 parent 1ec2e6b commit 897718a

File tree

1 file changed

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

1 file changed

+17
-15
lines changed

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

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,25 @@ dates:
1313
posted: 2024-10-07
1414
---
1515

16-
This tutorial shows you how to create a documentation website using the Scaleway [Object Storage bucket website](/storage/object/concepts/#bucket-website) feature with Material for MkDocs.
16+
This tutorial shows you how to create a documentation website using the Scaleway [Object Storage bucket website](/storage/object/concepts/#bucket-website) feature with MkDocs.
1717

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.
22+
2123
<Macro id="requirements" />
2224

2325
- A Scaleway account logged into the [console](https://console.scaleway.com)
2426
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2527
- Installed Python
2628
- Installed pip
27-
- Installed VS Code
29+
- Installed Visual Studio Code
2830
- Knowledge of the [Markdown](https://www.markdownguide.org/getting-started/#what-is-markdown) markup language
2931

3032
<Tabs id="install">
31-
<TabsTab label="Setting up MkDocs and configuring your website">
32-
1. Open the VS Code terminal and paste the following command to create a virtual environment to host your MkDocs content:
33+
<TabsTab label="Set up MkDocs and configure your website">
34+
1. Open the Visual Studio Code terminal and paste the following command to create a virtual environment to host your MkDocs content:
3335
```
3436
python -m venv envname
3537
```
@@ -174,7 +176,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
174176
name: Switch to light mode
175177
```
176178

177-
## Configuring fonts
179+
### Configuring fonts
178180

179181
Material for MkDocs integrates with [Google Fonts](https://fonts.google.com/) but you can also add custom fonts if you prefer.
180182

@@ -220,7 +222,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
220222
text: Roboto
221223
```
222224

223-
## Configuring navigation
225+
### Configuring navigation
224226

225227
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.
226228

@@ -237,11 +239,11 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
237239
- How to perform action three: perform-action-three.md
238240
```
239241

240-
## Configuring admonitions
242+
### Configuring admonitions
241243

242244
You can use admonitions to add side content to your documentation or make parts you want your users to notice stand out more. Refer to the [documentation](https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=admonitions#admonition-icons) to see available admonition icons.
243245

244-
### Enabling admonitions
246+
#### Enabling admonitions
245247

246248
Copy and paste the following code template to enable admonitions, make them collapsible, and nest content inside them.
247249

@@ -251,7 +253,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
251253
- pymdownx.details
252254
- pymdownx.superfences
253255
```
254-
### Adding admonition icons
256+
#### Adding admonition icons
255257

256258
Copy and paste the following code template to use Octicons admonition icons. You can also use the [FontAwesome admonition icons](https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=admonitions#admonition-icons-fontawesome).
257259

@@ -272,7 +274,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
272274
quote: octicons/quote-16
273275
```
274276

275-
### Using admonitions
277+
#### Using admonitions
276278

277279
The example below shows you the syntax you need to use in your files for admonitions. You can replace `info` with any of the admonitions you have added in the previous section (`abstract`, `note`, `tip`, `success`, `question`, `warning`, `failure`, `danger`, `bug`, `example`, and `quote`).
278280

@@ -300,7 +302,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
300302

301303
Find out more about admonitions on the [MkDocs website](https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=admonitions#configuration).
302304

303-
## Additional configuration
305+
### Additional configuration
304306

305307
You can add the following additional configuration options in your `mkdocs.yml` file. The `features` component allows you to use various features of the Material theme.
306308
```
@@ -330,21 +332,21 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
330332
copyright: >
331333
Copyright &copy; 2016 - 2024 Martin Donath
332334
```
333-
## Download the mkdocs file template
335+
## Downloading the mkdocs file template
334336

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

337339
<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>
338340

339341
</TabsTab>
340-
<TabsTab label="Preview your MkDocs website and deploy it">
342+
<TabsTab label="Preview and deploy your MkDocs website">
341343

342344
Once your website's content is ready and configured, you can preview it to make sure that everything displays properly.
343345

344346
## Previewing and generating a static website
345347

346-
1. Open the folder containing your `docs` directory in VS Code. The one we have created in this tutorial is named `my-folder`.
347-
2. Open the VS Code terminal and paste the following command:
348+
1. Open the folder containing your `docs` directory in Visual Studio Code. The one we have created in this tutorial is named `my-folder`.
349+
2. Open the Visual Studio Code terminal and paste the following command:
348350
```
349351
mkdocs serve
350352
```

0 commit comments

Comments
 (0)