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

Relax index file requirement in toc #1253

Open
fwkoch opened this issue May 28, 2024 · 0 comments
Open

Relax index file requirement in toc #1253

fwkoch opened this issue May 28, 2024 · 0 comments
Assignees

Comments

@fwkoch
Copy link
Collaborator

fwkoch commented May 28, 2024

Previous _toc.yml tocs required an index file to be valid. Similarly, our in-memory project structure requires an index file. This requirement makes some sense for site builds but does not make sense for exports (Currently, the index file is the default source of single-page exports but it is ignored for multi-page exports - very strange).

Since the new toc structure does not require an index file, we need to allow exports to define their toc with no index file, if that's the behaviour the user wants.

Further, projects need a way to infer an index file from a pattern top-level toc entry or maybe even a folder top-level entry. A few options:

  • Just take the first page as the index. This doesn't really work for top-level folders, as it pulls the index out of the folder.
  • Create a default index page
  • Redirect from the / root of the site to the first page, which may be in a folder
  • Or, we can just keep the index page requirement for projects/sites while relaxing it for exports - This is probably the easiest first pass.

Work on this issue will likely be directly tied in to #1243

@fwkoch fwkoch self-assigned this May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant