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
+17-15Lines changed: 17 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,23 +13,25 @@ dates:
13
13
posted: 2024-10-07
14
14
---
15
15
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.
17
17
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.
22
+
21
23
<Macroid="requirements" />
22
24
23
25
- A Scaleway account logged into the [console](https://console.scaleway.com)
24
26
-[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
25
27
- Installed Python
26
28
- Installed pip
27
-
- Installed VS Code
29
+
- Installed Visual Studio Code
28
30
- Knowledge of the [Markdown](https://www.markdownguide.org/getting-started/#what-is-markdown) markup language
29
31
30
32
<Tabsid="install">
31
-
<TabsTablabel="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
+
<TabsTablabel="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:
33
35
```
34
36
python -m venv envname
35
37
```
@@ -174,7 +176,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
174
176
name: Switch to light mode
175
177
```
176
178
177
-
## Configuring fonts
179
+
###Configuring fonts
178
180
179
181
Material for MkDocs integrates with [Google Fonts](https://fonts.google.com/) but you can also add custom fonts if you prefer.
180
182
@@ -220,7 +222,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
220
222
text: Roboto
221
223
```
222
224
223
-
## Configuring navigation
225
+
###Configuring navigation
224
226
225
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.
226
228
@@ -237,11 +239,11 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
237
239
- How to perform action three: perform-action-three.md
238
240
```
239
241
240
-
## Configuring admonitions
242
+
###Configuring admonitions
241
243
242
244
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.
243
245
244
-
### Enabling admonitions
246
+
####Enabling admonitions
245
247
246
248
Copy and paste the following code template to enable admonitions, make them collapsible, and nest content inside them.
247
249
@@ -251,7 +253,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
251
253
- pymdownx.details
252
254
- pymdownx.superfences
253
255
```
254
-
### Adding admonition icons
256
+
####Adding admonition icons
255
257
256
258
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).
257
259
@@ -272,7 +274,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
272
274
quote: octicons/quote-16
273
275
```
274
276
275
-
### Using admonitions
277
+
####Using admonitions
276
278
277
279
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`).
278
280
@@ -300,7 +302,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
300
302
301
303
Find out more about admonitions on the [MkDocs website](https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=admonitions#configuration).
302
304
303
-
## Additional configuration
305
+
###Additional configuration
304
306
305
307
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.
306
308
```
@@ -330,21 +332,21 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d
0 commit comments