Add option to ignore README.md

[davefp]

My book doesn't use README.md as the introduction. Instead, it's a guide to contributing, how to build the book, etc..

As such, I don't want it included in the summary at all. As far as I can tell this isn't possible. Adding the file to .bookignore causes the following error:

ENOENT, stat '/Users/david/code/books/webhookbook/_book/index.html'

My preferred solution would be an option entry in book.json called ignoreReadme or something similar that when set to true would simply let me skip adding the README to the summary.

[orelby]

I think so too. Including README.md in the book should be configurable. Also its path and file name, and SUMMARY.md's. The last one might not be necessary, but I hate that name. :-)

[davefp]

@OrelBeY That's probably a better solution. It could default to looking for README.md but if the path is set to nil in the json then it would just skip the default intro chapter altogether

[codepiano]

If the README.md is the first node of SUMMARY.md, gitbook will use it as the content of index.html.
Just set your own node name instead of the default 'Introduction' and use the README.md as the content of the index page.

# Summary

* [name_to_instead_of_introduction](README.md)
* [xxx](xxx.md)

[orelby]

@codepiano
Have you read the issue? It's not about changing the README.md's heading, but it's file path, and to be able to choose not to use it at all.

[codepiano]

@OrelBeY
I will try to complete this and send a pr.

[orelby]

@codepiano
Thank you. :-)

[codepiano]

In my own forked repo,I add config to specify the file name and title to generate introduction instead of README.md.But still need a introduction,it's difficult to totally ignore introduction.
And it is not properly to send a pr,because it changes the default behavier,if you really need this feature,you can use 'git cherrypick' to merge the commit into your own repo.

https://github.com/codepiano/gitbook
the commit is 5b648ac

add this in book.json

    "introduction": {
        "path": "your introduction path",
        "title": "your introduction title"
    }

[gbonanome]

+1 to the feature.

[petermichaux]

+1