Skip to content

Commit

Permalink
Fix some typos in website-navigation.qmd (#879)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yyzeng
yyzeng authored Oct 18, 2023
1 parent e4fdb10 commit d085c40
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/websites/website-navigation.qmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ There are a variety of options available for providing website navigation, inclu

- Using side navigation with a hierarchy of pages.

- Combining top and side navigation (where top navigation links to different sections of the site each with their own side navigation).
- Combining top and side navigation (where top navigation links to different sections of the site with their own side navigation).

In addition, you can add full text search to either the top or side navigation interface.

Expand Down Expand Up @@ -58,14 +58,14 @@ Here are all of the options available for top navigation:
| `logo` | Logo image to be displayed left of the title. |
| `logo-alt` | Alternate text for the logo image. |
| `logo-href` | Target href from navbar logo / title. By default, the logo and title link to the root page of the site (`/index.html`). |
| `background` | Background color ("primary", "secondary", "success", "danger", "warning", "info", "light", "dark", or hex color) |
| `background` | Background color ("primary", "secondary", "success", "danger", "warning", "info", "light", "dark", or hex color). |
| `foreground` | Foreground color ("primary", "secondary", "success", "danger", "warning", "info", "light", "dark", or hex color). The foreground color will be used to color navigation elements, text and links that appear in the navbar. |
| `search` | Include a search box (true or false) |
| `search` | Include a search box (true or false). |
| `tools` | List of navbar tools (e.g. link to github or twitter, etc.). See [Navbar Tools](#navbar-tools) for details. |
| `left` / `right` | Lists of navigation items for left and right side of navbar |
| `pinned` | Always show the navbar (true or false). Defaults to false, and uses [headroom.js](https://wicky.nillia.ms/headroom.js/) to automatically show the navbar when the user scrolls up on the page. |
| `collapse` | Collapse the navbar items into a hamburger menu when the display gets narrow (defaults to true) |
| `collapse-below` | Responsive breakpoint at which to collapse navbar items to a hamburger menu ("sm", "md", "lg", "xl", or "xxl", defaults to "lg") |
| `left` / `right` | Lists of navigation items for left and right side of navbar. |
| `pinned` | Always show the navbar (true or false). Defaults to false, and uses [headroom.js](https://wicky.nillia.ms/headroom.js/) to automatically show the navbar when the user scrolls up on the page. |
| `collapse` | Collapse the navbar items into a hamburger menu when the display gets narrow (defaults to true). |
| `collapse-below` | Responsive breakpoint at which to collapse navbar items to a hamburger menu ("sm", "md", "lg", "xl", or "xxl", defaults to "lg"). |

Here are the options available for individual navigation items:

Expand Down Expand Up @@ -152,16 +152,16 @@ Here are all of the options available for side navigation:
|------------------|------------------------------------------------------|
| `id` | Optional identifier (used only for hybrid navigation, described below). |
| `title` | Sidebar title (uses the project title if none is specified). |
| `subtitle` | Optional subtitle |
| `logo` | Optional logo image |
| `subtitle` | Optional subtitle. |
| `logo` | Optional logo image. |
| `search` | Include a search box (true or false). Note that if there is already a search box on the top navigation bar it won't be displayed on the sidebar. |
| `tools` | List of sidebar tools (e.g. link to github or twitter, etc.). See the next section for details. |
| `items` | List of navigation items to display (typically top level items will in turn have a list of sub-items). |
| `style` | "docked" or "floating" |
| `type` | "dark" or "light" (hint to make sure the text color is the inverse of the background) |
| `style` | "docked" or "floating". |
| `type` | "dark" or "light" (hint to make sure the text color is the inverse of the background). |
| `background` | Background color ("none", "primary", "secondary", "success", "danger", "warning", "info", "light", "dark", or "white"). Defaults to "light". |
| `foreground` | Foreground color ("primary", "secondary", "success", "danger", "warning", "info", "light", "dark", or hex color). The foreground color will be used to color navigation elements, text and links that appear in the sidebar. |
| `border` | Whether to show a border on the sidebar. "true" or "false" |
| `foreground` | Foreground color ("primary", "secondary", "success", "danger", "warning", "info", "light", "dark", or hex color). The foreground color will be used to color navigation elements, text and links that appear in the sidebar. |
| `border` | Whether to show a border on the sidebar. "true" or "false". |
| `alignment` | Alignment ("left", "right", or "center"). |
| `collapse-level` | Whether to show sidebar navigation collapsed by default. The default is 2, which shows the top and next level fully expanded (but leaves the 3rd and subsequent levels collapsed). |
| `pinned` | Always show a title bar that expands to show the sidebar at narrower screen widths (true or false). Defaults to false, and uses [headroom.js](https://wicky.nillia.ms/headroom.js/) to automatically show the navigation bar when the user scrolls up on the page. |
Expand All @@ -170,7 +170,7 @@ For more information on controlling the appearance of the side navigation using

### Auto Generation

Above we describe how to explicitly populate the `contents` of your sidebar with navigation items. You can also automatically generate sidebar navigation from the filesystem. The most straightforward way to do this is to specify the `auto: true` option as follows:
Above we describe how to explicitly populate the `contents` of your sidebar with navigation items. You can also automatically generate sidebar navigation from the filesystem. The most straightforward way to do this is to specify the `contents` option as follows:

``` yaml
sidebar:
Expand All @@ -192,7 +192,7 @@ sidebar:
contents: /*
```

Rather than specifying that all documents should be included, you can also specify a directory name or a glob pattern. For example, the following values for `auto` are all valid (note that the second form for `reports` is non-recursive):
Rather than specifying that all documents should be included, you can also specify a directory name or a glob pattern. For example, the following values for `contents` are all valid (note that the second form for `reports` is non-recursive):

``` yaml
sidebar:
Expand Down Expand Up @@ -454,7 +454,7 @@ website:
repo-actions: [edit, issue]
```

The links will be displayed immediately below the page table of contents:
The links will be displayed immediately below the page's table of contents:

![](images/repo-actions.png){.border fig-alt="A screen shot of a Quarto document. Underneath the page table of contents on the right side are two options: 'Edit this page' and 'Report an issue'. There is a Github icon to the left of 'Edit this Page.'"}

Expand Down

0 comments on commit d085c40

Please sign in to comment.