Improve outline configuration #2

New issue

Closed

opened 2020-02-05 11:16:39 +00:00 by liska · 0 comments

liska commented

2020-02-05 11:16:39 +00:00

Owner

I think the reading of the project outline can be improved by assuming that a first book with the name main is the main book. There will never be the need for a custom name, especially since this particular name will not be used as a path segment.

We use oyaml so we have ordered dictionaries, so I suggest the following syntax for the outline.yml file:

main:
  title: "The great book"
intro:
  title: "Introduction"
api:
  title: "API documentation"

This will result in a site with main book and two subbooks with the path segments intro and api

I think the reading of the project outline can be improved by assuming that a *first* book with the name `main` *is* the main book. There will never be the need for a custom name, especially since this particular name will *not* be used as a path segment. We use `oyaml` so we have ordered dictionaries, so I suggest the following syntax for the `outline.yml` file: ```yaml main: title: "The great book" intro: title: "Introduction" api: title: "API documentation" ``` This will result in a site *with* main book and two subbooks with the path segments `intro` and `api`