Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Sync to prerelease] Don't imply different behaviour for chapter numbering in index.qmd #1139

Merged
merged 1 commit into from
Jun 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/books/book-structure.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ book:
- references.qmd
```

- The `index.qmd` file is required (because Quarto books also produce a website in HTML format). This page should include the preface, acknowledgements, etc. and headings in the `index.qmd` file are unnumbered by default. The HTML version of the book will use the `index.qmd` as the home page and if provided, will place the `cover-image` on that page.
- The `index.qmd` file is required (because Quarto books also produce a website in HTML format). This page should include the preface, acknowledgements, etc. The HTML version of the book will use the `index.qmd` as the home page and if provided, will place the `cover-image` on that page.
- The remainder of `chapters` includes one or more book chapters.
- The `references.qmd` file will include the generated bibliography (see [References] below for details).

Expand All @@ -46,10 +46,10 @@ In the absence of a level-one header or a title set in the YAML front matter, th

## Chapter Numbers

All chapters are numbered by default. If you want a chapter to be unnumbered simply add the `.unnumbered` class to its main header. For example:
All chapters are numbered by default. If you want a chapter to be unnumbered simply add the `.unnumbered` class to its main header. For example, it is common to omit the chapter number for `index.qmd`:

``` markdown
# Resources {.unnumbered}
```{.markdown filename="index.qmd"}
# Preface {.unnumbered}
```

You can mix together numbered and unnumbered chapters. Note however that while you can link to unnumbered chapters, you can't [cross reference](/docs/authoring/cross-references.qmd) figures, tables, etc. within them. Unnumbered chapters are therefore mostly useful for prefatory content or references at the end of your book.
Expand Down