Well, this is going to be a large chapter. You might want to have some coffee or tea while reading it, because this section is used to specify what goes into the Website generated by Little Webby Press and it contains a lot of fields.
[site] enabled = true theme = "generic" frontmatter = [ ] chapters = [ ] backmatter = [ ] blurb = false landing = true download = true [site.actions] download = "Download the eBook" read = "Free To Read Online" toc = "Table Of Contents" [site.labels] about-book = "About The Book" about-author = "About The Author" toc = "Table Of Contents" ereader-compatible = "Compatible with most eReaders" support-with-webmo = "Support this work by using" read = "Free To Read Online" license = "License"
You can simply ommit this section and have the site be generated according to the data in the
[book] section. Still, I think you should have this filled in with at least the blurb field.
A lot of these sections are similar to the book section, in these cases they behave exactly the same thus allowing you to override the values for the same fields on the Website.
If you want to use Little Webby Press just to assemble your eBooks, you can disable the Website generation by setting this field to
enabled = false
The default behaviour is to generate a Website. It is important to understand that even if that is the default behaviour, there is a separate button on the interface for the Generate Site action. Clicking only the Generate eBook action button, will cause only the eBook to be assembled. So, even all you want is an eBook, you can use the default settings and simply not click hte Generate Site action.
Some authors already have their own platform and website set up. In these cases, Little Webby Press is most useful as a tool to assemble eBooks only.
Which theme should be used to generate the Website. At the moment we only have one theme called generic. In the near future we plan to have more themes, and also a way for you to override our theme selection and provide your own. Right now, you should simply ignore this field.
theme = "generic"
These behave exactly the same as their counterparts in the book section. The reason for having them here is to enable you to override the values. For example, suppose you just want a sample to be present in the website for the visitors to read, you could do something like
chapters = [ "001-life-is-good.md", "002-life-still-good-but-other-pov.md", "003-shit-happens.md", "004-accepting-the-shit-is-hard.md", "005-mentor-appears.md", "end-of-sample-if-you-like-buy-this-shit.md" ]
And the version of the
chapters field used by the website would not be the same as the one in the eBook.
If you don’t fill these fields, the version of the book section will be used.
This is the marketing blurb that is placed on the website. It serves the same purpose as the text usually found in the back cover of a paperback. It’s main reason for existing is to convert visitors into readers.
blurb = """ In this award-winning book (my mom gave me an award at age five for outlining this story), you follow our heroine as she overcome challenges and finds friendship along the way. > "You should totally read this shit!" — not GRR Martin. """
You can use Markdown to write that field. It appears only on the Website.
When Little Webby Press generates a website for your book, it creates a landing site and also a web-readable version of the book. This manual you’re reading is this webby version of the Book Configuration File Specification eBook.
For some books – such as this manual – it doesn’t make sense to have a landing page, and all you want is the webby version of the book. In these cases, you can set landing to
landing = false
The default behaviour of the Website is to provide download links for the eBook. If you don’t want the visitor to be able to download the ePub, you can set this value to
download = false
So this is a new type of section that you haven’t seen before, it has a period in its name and that period is important. What that period means is that we’re creating a subsection.
There is the site section that starts with:
And inside the site section there is the actions subsection that starts with:
The actions are the buttons that appear on the top part of the website allowing the user to download the book, read the book online, and browse the table of contents.
What this section does, is allow you to change the text on these buttons. Being able to specify your own text is important because you book and audience might not be English-speakers and it makes no sense to have a book written in a language and the Website buttons in another.
At the moment there is no way for Little Webby Press to generate sites in multiple languages, so we advise that if your book is in a language that is not English, that you specify these fields in the same language.
[site.actions] download = "Baixe o Livro" read = "Leia Online" toc = "Índice"
Similarly to the previous section, the site labels section can be used to override all the labels in the website template. This way you can localise the website in your own language.
[site.labels] about-book = "Sobre o Livro" about-author = "Sobre o Autor" toc = "Índice" ereader-compatible = "Compatível com leitores digitais" support-with-webmo = "Apoie esse trabalho" read = "Leia Online" license = "Licença"