Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #372 and add booklet to website/repo #439

Merged
merged 3 commits into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,15 @@ 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)

We recommend using double-sided printing if your printer supports it.

## Online HTML version

Expand Down
174 changes: 0 additions & 174 deletions book/booklet.tex

This file was deleted.

27 changes: 2 additions & 25 deletions book/makefile
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,6 @@ website_assets := $(wildcard ../website/assets/*)
ruby_src := ../website/modify_build.rb $(website_assets)
ruby_pkg := ../website/Gemfile ../website/Gemfile.lock

# This is more than what is actually needed but keeps the makefile simple
booklet_src := $(src_figures) $(src_tables) $(src_recipes) $(images)
booklet_src += booklet.tex
# }}}

# Flowcharts {{{
# TODO: check if it works on github CI
%.png: %.tex
Expand All @@ -113,12 +108,6 @@ book_serif/book.pdf: $(src_all)

book_sans_serif/book_sans_serif.pdf: $(src_all)
$(LATEX) -output-directory=book_sans_serif book_sans_serif.tex

# We don't want to use latexmk as there is no biber nor references and it
# seems to make it somehow unhappy
booklet/booklet.pdf: $(booklet_src)
mkdir -p booklet
lualatex --output-directory=booklet booklet.tex
# }}}

# Ebook {{{
Expand Down Expand Up @@ -199,11 +188,10 @@ export_figures: pdf $(tgt_figures)
all: bake

# Finally actual project targets (i.e. build pdf and ebooks)
.PHONY: pdf booklet serif sans_serif ebook
.PHONY: pdf serif sans_serif ebook

pdf: serif sans_serif

booklet: booklet/booklet.pdf
serif: book_serif/book.pdf
sans_serif: book_sans_serif/book_sans_serif.pdf

Expand All @@ -213,7 +201,6 @@ low_res_ebook: epub/low_res_book.epub

# We keep the old target names for backward compatibility
build_pdf: pdf
build_booklet: booklet
build_serif_pdf: serif
build_sans_serif_pdf: sans_serif
build_ebook: ebook
Expand All @@ -222,7 +209,7 @@ build_low_res_ebook: low_res_ebook

# top level releases rules
.PHONY: bake release_serif release_sans_serif
bake: release_serif release_sans_serif release_booklet website
bake: release_serif release_sans_serif website

release:
mkdir -p release
Expand All @@ -239,9 +226,6 @@ release_serif: serif ebook bw_ebook low_res_ebook | release

release_sans_serif: sans_serif | release
cp book_sans_serif/book_sans_serif.pdf release/TheBreadCode-The-Sourdough-Framework-sans-serif.pdf

release_booklet: booklet | release
cp booklet/booklet.pdf release/TheBreadCode-The-Sourdough-Framework-booklet.pdf
# }}}

# Clean up {{{
Expand Down Expand Up @@ -274,20 +258,17 @@ clean_website_build:
clean: clean_ebook_build clean_figures clean_website_build
$(CLEAN) -output-directory=book_serif book.tex
$(CLEAN) -output-directory=book_sans_serif book_sans_serif.tex
$(CLEAN) -output-directory=booklet booklet.tex
-rm book*/*.{bbl,loc,run.xml}

mrproper: clean
$(CLEAN) -C $(src_figures)
$(CLEAN) -C -output-directory=book_serif book.tex
$(CLEAN) -C -output-directory=book_sans_serif book_sans_serif.tex
$(CLEAN) -C -output-directory=booklet booklet.tex
-rm figures/*.png
-rm -rf epub/
-rm -rf release/
-rm -rf book_serif/
-rm -rf book_sans_serif/
-rm -rf booklet/
-rm -rf *book-epub/
-rm -rf epub_build/
-rm -rf website_build/
Expand Down Expand Up @@ -338,7 +319,6 @@ help:
@echo "Quick builds:"
@echo " quick: compiles serif_pdf but runs lulatex only once"
@echo " quick_ebook: compiles ebook but runs lulatex only once"
@echo " quick_booklet: compiles booklet but runs lulatex only once"
@echo ""
@echo "Checks:"
@echo " tex-check: runs static analysis checker on LaTeX source to spot"
Expand Down Expand Up @@ -383,9 +363,6 @@ spell-check: $(src_tex) spelling_exceptions.txt
quick: # run latex only once no biber, no references etc...
$(LATEX) -e '$$max_repeat=1' -halt-on-error -output-directory=book_serif book.tex

quick_booklet:
$(LATEX) -e '$$max_repeat=1' -halt-on-error -output-directory=booklet booklet.tex

quick_ebook: cover/cover-page.xbb # run latex only once no biber, ref etc...
$(EBOOK) --mode draft book.tex

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
5 changes: 1 addition & 4 deletions makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ DOCKER_CMD := docker run --rm -it -v $(PWD):/opt/repo --platform linux/x86_64 $(

.PHONY: bake build_pdf build_docker_image push_docker_image validate website
.PHONY: print_os_version start_shell printvars show_tools_version mrproper
.PHONY: build_serif_pdf build_ebook booklet
.PHONY: build_serif_pdf build_ebook

# Dockers targets
build_docker_image:
Expand All @@ -30,9 +30,6 @@ bake:
website:
$(DOCKER_CMD) "cd /opt/repo/book && make website"

booklet:
$(DOCKER_CMD) "cd /opt/repo/book && make booklet"

mrproper:
$(DOCKER_CMD) "cd /opt/repo/book && make mrproper"

Expand Down
Loading
Loading