quarto-dev / quarto-dev/quarto-cli

Add Support for Books With No `index.qmd` File

Open
#2,556 3 comments 18 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

books enhancement
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

Discussed in https://github.com/quarto-dev/quarto-cli/discussions/2512

Originally posted by iusgit September 20, 2022
Hi,

first thanks for this wonderful tool!

I created a book project and one output format is a docx (unfortunately... I'm not a friend of this, but the project commands it).

My book looks like this:

book:
  chapters:
    - index.qmd
    - content/Chapter_01.qmd
    - content/Chapter_02.qmd

File index.qmd is empty, I would get an error during rendering if I would remove it. However, with file index.qmd comes automagically an additional chapter that is unwanted and in my opinion not useful at all.

Any idea how to unset the additional chapter?

Help is appreciated!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the book project's book.chapters configuration and compare rendering with and without index.qmd. Confirm the current error and the extra chapter behavior; done means a book can render without index.qmd and does not create an unwanted chapter.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.