Skip to content

Commit c38ef33

Browse files
committed
chore(basic_structure): alter example yaml to match template
1 parent 99dbbfa commit c38ef33

1 file changed

Lines changed: 25 additions & 18 deletions

File tree

pages/basic_structure/index.qmd

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,28 +32,35 @@ project: # <1>
3232

3333
website: # <1>
3434
title: "Quarto Template" # <2>
35-
favicon: images/exeter.png # <3>
36-
navbar: # <4>
37-
right: # <5>
38-
- icon: github # <5>
39-
text: GitHub # <5>
40-
href: https://github.com/pythonhealthdatascience/quarto-template/ # <5>
41-
sidebar: # <6>
42-
- logo: images/exeter.png # <7>
43-
contents: # <8>
44-
- text: Overview # <8>
45-
href: index.qmd # <8>
46-
- pages/TODO.qmd # <8>
35+
navbar: # <3>
36+
right: # <4>
37+
- icon: github # <4>
38+
text: GitHub # <4>
39+
href: https://github.com/pythonhealthdatascience/quarto-template/ # <4>
40+
sidebar: # <5>
41+
- logo: images/exeter.png # <6>
42+
contents: # <7>
43+
- text: Overview # <7>
44+
href: index.qmd # <7>
45+
- pages/1_making_a_change.qmd # <7>
46+
- pages/2_markdown_basics.qmd # <7>
47+
- pages/3_quarto_features.qmd # <7>
48+
- pages/4_images_videos_documents.qmd # <7>
49+
- pages/5_inline_html.qmd # <7>
50+
51+
format: # <8>
52+
html: # <8>
53+
theme: default # <8>
4754
```
4855
4956
1. **Website:** Defines that this project builds as a website.
5057
2. **Website title:** Appears in broswer tab and navbar.
51-
3. **Favicon:** The small icon shown on the tab (often a logo).
52-
4. **Navbar:** The navigation bar across the top of your site.
53-
5. **GitHub link:** Adds a GitHub icon on the right side of the navbar linking to the repository (which contains the source files for the site).
54-
6. **Sidebar:** Displays navigation links down the left-hand side.
55-
7. **Logo:** The image shown at the top of the sidebar.
56-
8. **Sidebar contents:** Lists website pages. Will list using page titles by default, but can override with `text` (title to use) and `href` (path to file).
58+
3. **Navbar:** The navigation bar across the top of your site.
59+
4. **GitHub link:** Adds a GitHub icon on the right side of the navbar linking to the repository (which contains the source files for the site).
60+
5. **Sidebar:** Displays navigation links down the left-hand side.
61+
6. **Logo:** The image shown at the top of the sidebar.
62+
7. **Sidebar contents:** Lists website pages. Will list using page titles by default, but can override with `text` (title to use) and `href` (path to file).
63+
8. **Theme:** Site theme (covered on [Customising the site appearance](/pages/customising/index.qmd) page).
5764

5865
::: {.callout-note title="Optional extra: books" collapse="true"}
5966

0 commit comments

Comments
 (0)