Skip to content

Commit

Permalink
Fix #372 and add booklet to website/repo
Browse files Browse the repository at this point in the history
This adds the design TLDR version to the README and website
  • Loading branch information
hendricius committed Jan 23, 2025
1 parent 3e602fa commit 58bc0df
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 38 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,16 @@ size. This shrinks the book from more than 20MB down to ~5MB:

* [Download compiled B&W .epub version](https://www.the-bread-code.io/bw-book.epub)

If you prefer a very short version (about 10 pages) with main flowcharts and
crucial information needed while you are in the kitchen, we also provide a
"too long;didn't read" version you could print. Having read the full book is
highly recommended to understand this leaflet:
For those who prefer a concise reference (about 15 pages), we offer a "too long;didn't read" (TL;DR)
version. This condensed guide contains the essential flowcharts, crucial information,
and space for your notes - perfect for quick kitchen reference.
It provides the key information you need without reading the complete book.

* [Download a condensed version](https://www.the-bread-code.io/booklet.pdf)
* [Read TL;DR version on your device](https://the-bread-code.io/book-tldr-print.pdf)
* [Download TL;DR version for printing](https://the-bread-code.io/book-tldr-digital.pdf)

For printing, we recommend using double-sided printing if your printer supports it. Else you
have to print page by page and then flip them. You can use a stapler to bind the pages.

## Online HTML version

Expand Down
16 changes: 16 additions & 0 deletions book/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,22 @@ figure.figure p.noindent {
text-align: center;
}

main.main-content h2.chapterHead.home-content-title {
margin-top: 0.5em;
margin-bottom: 0.5em;
line-height: 1.5em;
}

.download-description {
font-weight: var(--fw-bold);
}

.download-links {
p.indent, p.noindent {
text-align: unset;
}
}

@media (max-width: 768px) {
.header {
display: none;
Expand Down
60 changes: 27 additions & 33 deletions website/modify_build.rb
Original file line number Diff line number Diff line change
Expand Up @@ -626,15 +626,16 @@ def build_cover_page_content
Creating this book has been a labor of love. My
main goal has always been to spread the joy of baking and empower bread
enthusiasts like yourself. To ensure that the book remains accessible
to everyone, I have decided to make it available as a free digital download.
to everyone, I have decided to make it available free of charge.
</p>
<a href="bread.jpg">
<img alt="One of my best Sourdough Breads" class="home-bread" src="bread.jpg" />
</a>
<h2 class="chapterHead home-content-title">⭐ Support this project</h2>
<p class="noindent">
However, producing and maintaining resources like this requires
Producing and maintaining resources like this requires
considerable time, effort, and financial investment. If you find value
in "The Sourdough Framework" and appreciate the effort that went into
creating it, I kindly request your support <a href="https://breadco.de/book">
Expand All @@ -646,18 +647,7 @@ def build_cover_page_content
<p class="noindent">
Your generous contribution will not only help me cover the costs associated
with this project but will also enable me to continue creating more valuable
content in the future.
</p>
<p class="noindent">
If you feel inspired to contribute, please consider making a donation of
any amount through <a href="https://breadco.de/book">my donation page</a>.
Your support will go a long way in ensuring
that this knowledge can reach even more bread enthusiasts worldwide.
</p>
<p class="noindent">
Remember, your donation is entirely voluntary and any amount you
content in the future. Your donation is entirely voluntary and any amount you
contribute is deeply appreciated. If you are unable to make a donation at
this time, please know that your readership and support in spreading the
word about "The Sourdough Framework" are invaluable contributions as well.
Expand All @@ -669,29 +659,33 @@ def build_cover_page_content
Together, we can continue to share the love of baking and cultivate a
community passionate about the art of sourdough.
</p>
<p class="noindent">
You can either browse through this page or download the full book directly:
</p>
<p class="noindent">
PDF: <a href="https://www.the-bread-code.io/book.pdf">https://www.the-bread-code.io/book.pdf</a><br>
PDF (no serif): <a href="https://www.the-bread-code.io/book-sans-serif.pdf">https://www.the-bread-code.io/book-sans-serif.pdf</a>
</p>
<p class="noindent">
EPUB: <a href="https://www.the-bread-code.io/book.epub">https://www.the-bread-code.io/book.epub</a><br>
EPUB in Black & White, size optimized for screen readers : <a href="https://www.the-bread-code.io/bw-book.epub">https://www.the-bread-code.io/bw-book.epub</a><br>
</p>
<h2 class="chapterHead home-content-title">⬇️ Versions</h2>
<p class="noindent">
The full source code of the book can be found here:
<a href="https://www.github.com/hendricius/the-sourdough-framework">https://www.github.com/hendricius/the-sourdough-framework</a>
You can either browse through this website or download the full book to read it on your preferred device:
</p>
<p class="noindent">
There's also a hardcover version of the book available featuring an even more awesome design. You can read more information here:
<a href="https://www.breadco.de/hardcover-book">https://www.breadco.de/hardcover-book</a>
</p>
<div class="download-links">
<p class="noindent">
<span class="download-description">PDF:</span> <a href="https://www.the-bread-code.io/book.pdf">https://www.the-bread-code.io/book.pdf</a><br>
<span class="download-description">PDF (no serif):</span> <a href="https://www.the-bread-code.io/book-sans-serif.pdf">https://www.the-bread-code.io/book-sans-serif.pdf</a>
</p>
<p class="noindent">
<span class="download-description">EPUB:</span> <a href="https://www.the-bread-code.io/book.epub">https://www.the-bread-code.io/book.epub</a><br>
<span class="download-description">EPUB black & white:</span> <a href="https://www.the-bread-code.io/bw-book.epub">https://www.the-bread-code.io/bw-book.epub</a><br>
</p>
<p class="noindent">
<span class="download-description">Short TL;DR version:</span> <a href="https://the-bread-code.io/book-tldr-digital.pdf">https://the-bread-code.io/book-tldr-digital.pdf</a><br>
<span class="download-description">Short TL;DR version (print):</span> <a href="https://the-bread-code.io/book-tldr-print.pdf">https://the-bread-code.io/book-tldr-print.pdf</a><br>
</p>
<p class="noindent">
<span class="download-description">Sauce code:</span>
<a href="https://www.github.com/hendricius/the-sourdough-framework">https://www.github.com/hendricius/the-sourdough-framework</a>. Contributions and improvements are highly appreciated!
</p>
</div>
<p class="noindent">
Thank you and may the gluten be strong with you,<br>
Expand Down

0 comments on commit 58bc0df

Please sign in to comment.