gitbook-cli

gitbook-cli copied to clipboard

Hi,

This is not really a bug report, since there is a clear error message associated, but a simple feature that would be great to have :)

I would like to have a manual associated to an existing project with minimum interference with the project itself. For that, I would love to simply have a book.json file and a manual folder in the root of my project, and put everything else within manual. However, when I attempt to set any of readme, summary, or glossary to a path within manual I get an error like: ConfigurationError: Error with book's configuration: config.structure.readme does not match pattern "^[0-9a-zA-Z ... ]+$".

My current workaround was to have these three files in the root as dot-files, so at least they would be hidden (.README.md, .SUMMARY.md, and .GLOSSARY.md), and link from there to files within manual. However, they're still in the root (e.g., when looking at the GitHub tree) and it's very inconvenient to have to add the manual/ prefix to every single link in .SUMMARY.md.

Thanks!

BTW, I also tried to place them in .book-summary.md or .book_summary.md, and both options fail with the same error. Probably this latter is just a matter of relaxing the regexp a little, I'm guessing a dash and/or an underscore in the path wouldn't be much of an issue.

The documentation says:

“These files must be at the root of your book (or the root of every language book). Paths such as dir/MY_README.md are not accepted.”

I ran into the same problem, would be really nice to have the option to keep all .md files in a single directory.