Commit Graph

202 Commits

Author SHA1 Message Date
Hendrik Kleinwaechter
d1ff67415f Fix more issues with docker build 2023-07-10 10:42:30 +02:00
cedounet
ee7db7b481 Fix links colors (#144)
* Add chemfig package

Somhow forgot it in chemical equation commit 8004497b

* Change links colors to codeblue

Closes https://github.com/hendricius/the-sourdough-framework/issues/142
2023-07-09 20:38:56 +02:00
Hendrik Kleinwaechter
46ab05048e Fix Docker workflow issues (hopefully) (#143)
This hopefully fixes some of the issues of the docker workflow building
the book and website
2023-07-09 15:05:30 +02:00
cedounet
58004497bd Chemical eq (#141)
* Update README

- Need latexmk
- How to get limited help on build instuctions

* Rewrite chemical equation

Write it from scratch rather than a pixalated picture
2023-07-09 12:56:49 +02:00
cedounet
3ae735c4bb Update README (#140)
- Need latexmk
- How to get limited help on build instuctions
2023-07-09 12:56:25 +02:00
Hendrik Kleinwaechter
acace08de1 Change into folder 2023-07-08 12:07:44 +02:00
Hendrik Kleinwaechter
eda0975d84 Tag with 'latest' 2023-07-08 11:24:25 +02:00
Hendrik Kleinwaechter
3b5187042f Build image only on main 2023-07-08 10:55:44 +02:00
Hendrik Kleinwaechter
c7e9366de4 Change entry point 2023-07-08 10:53:38 +02:00
Hendrik Kleinwaechter
509092c56e Improve website deployment (#139)
* Fix issue of book not building

* add dependencies

* fix

* test make4ht

* fix cmd

* Use own docker image

* Add label

* fix urls

* Add validate command

* build non mac version

* tmp run

* use smaller tex version

* build full
2023-07-08 10:51:23 +02:00
Hendrik Kleinwaechter
62a9e9a000 Style improvements website (#138)
* Improve general CSS for website

* Update github flow
2023-07-07 13:38:56 +02:00
Hendrik Kleinwaechter
cc96559b6b Add book title to website html 2023-07-07 12:30:08 +02:00
Hendrik Kleinwaechter
036031fda8 Fix missing design 2023-07-07 12:14:17 +02:00
Hendrik Kleinwaechter
b5491096b0 Website improvements for book (#137) 2023-07-06 09:01:35 +02:00
Hendrik Kleinwaechter
f2ac5a37f7 Fix dir names 2023-07-03 16:36:21 +02:00
Hendrik Kleinwaechter
ef373f308d Fix dir name 2023-07-03 16:18:19 +02:00
Hendrik Kleinwaechter
0822ba81df Fix bucket name 2023-07-03 11:23:08 +02:00
Hendrik Kleinwaechter
bcfe67d4df Static HTML Website (alpha version) (#136)
This is a minimal alpha version of the book as static html website. More
stuff needs to be added, but should be okay for a working prototype.
Fixes #128
2023-07-03 09:21:25 +02:00
cedounet
ab608c7311 Remove building sans-serif ebook in CI (#135)
They are not needed as you can change the font in your reader.
Closes: https://github.com/hendricius/the-sourdough-framework/issues/131
2023-06-30 11:48:32 +02:00
cedounet
17b5ae5f52 Various clean up (#134)
* Fix reference and grammar

* Remove obsolete package

* Use colored links in pdf, black when printed

We can debate the colors to use of course, I left the defaults in.
There are accessibility concerns with colors...

* Add supporter.csv to the list of TeX source

So we rebuild everytime we add a new supporter.

* Inline the list of supporters

Those guys are awesome, but do they really need to be in a table one per
line over 3 pages?

* Explicit figure location

h rarelly works, so making it clear top is also an option.
2023-06-30 11:47:09 +02:00
cedounet
2582e4c180 Fix reference and grammar (#133) 2023-06-30 11:46:39 +02:00
Hendrik Kleinwaechter
c98600b109 Fix spelling mistake on cover
This fixes a type on the cover page of the book. Fixes #101
2023-06-29 14:34:00 +02:00
Hendrik Kleinwaechter
5d42f86c66 Spelling Fixes
Thanks Roberto von Krammer for the feedback!
2023-06-29 14:25:39 +02:00
Hendrik Kleinwaechter
0664fe5b0e Add note on temperature and milling flour (#132)
This just adds a small note on temperature when milling flour. The
provided source is an interesting read.
2023-06-29 13:48:17 +02:00
Hanso707
cd1130903d Fixed typos and grammar (#130)
* Update sourdough-starter.tex

Fixed 'typo'

* Update sourdough-starter.tex

take 3 days or so -> take about 3 days

* Update sourdough-starter-types.tex

logical mistake

* Update sourdough-starter-types.tex

logic: doesnt make sense to apply the method without any mold

* Update flour-types.tex

grammar

* Update bread-types.tex

grammar

* Update baking.tex

grammar

* Update sourdough-starter-types.tex

recommendation, wording

* Update flour-types.tex

recommendation, wording

* Update wheat-sourdough.tex

recommendation, wording

* Update wheat-sourdough.tex

get rid of repetition of 'hardly' - recommendation, wording

* Update baking.tex

get rid of 'so'
recommendation, wording

---------

Co-authored-by: Hendrik Kleinwaechter <hendrik.kleinwaechter@gmail.com>
2023-06-28 20:32:03 +02:00
cedounet
4637c29a37 Use Siunitx package for dealing with units (#129)
It is complicated :
[1] The International System of Units (si), https://www.bipm.org/en/
measurement-units/.
[2] International System of Units from nist, http://physics.nist.gov/cuu/Units/
index.html.

And one will never get it right (space or not, half-space?) nor
consistent so using that instead.

I am not sure how times and hours, when to write digits and when in
letter so I did not change much..

Did not touch the tables as ebooks on github actions seems to break when
you look at them funny.

Co-authored-by: Cedric <ced@awase.ostal>
2023-06-28 20:30:12 +02:00
Hendrik Kleinwaechter
0614fe7d8f Fix export figures (#127)
This fixes the export figures command
2023-06-27 14:31:08 +02:00
cedounet
5731a49828 Remove superflous equal sign (#126)
and traling spaces while at it
2023-06-27 11:22:25 +02:00
Hendrik Kleinwaechter
123ec73cea Use locally built tex4ebook 2023-06-27 11:21:59 +02:00
cedounet
05c33a76b6 Use input figs (#123)
* Make figs includable in main document

Remove the capability to build them as standalone document but we can
include them in the main document.  It should simplify things down the
road.

* Replace tikx pics

* Remove figures compilation from makefile

No need to compile figs to pdf anymore, at least to build the books

* Delete svg figures from ebook build

* Create png for TikZ figures

    - Add export_figures back
    - Build a pdf from the the TikZ in standalone mode
    - Change the cleanup to deal with those changes
    - Remove trailing spaces..

* Replace centering by an environment

More LaTeX idomatic

* Increase clean_figures robustness

as we use temporary tex files (.tex.in) we can't run clean_figures twice in a
row

* Center TikZ figures

Because it looks better

* Remove png building

Seems to struggle on CI with \\\b or something, we don't absolutely need
it right now so let's get rid of it.

* Remove trgt_figures dependency for pdf and ebooks

This should not be needed now that we include the TikZ directly, only
needed for png generation.

* Revert "Remove png building"

This reverts commit fdd542de57.

This is now fine to add the code back, so that it can be debugged when
times come.
2023-06-27 11:07:19 +02:00
cedounet
e72d6e1771 Remove a manual enumerate (#125)
Now using adequate environment for it
2023-06-26 16:04:17 +02:00
cedounet
179e8af62e Makefile bugs fix and debug info (#124)
* Update .gitignore

Hide the svg file created during ebook builds and the new directories
after makefile changes

* Fix a makefile variable that stayed in uppercase

* Do not clean ebook systematically anymore

Should be fixed with new way to build ebooks

* Add rule showing version of tools on build machine

This helps with debugging on another machine.. or a build server.

* Add figures/vars.tex to the list of dependencies

Was missing...

* Add a makefile variable print facility

Quite a neat trick, avoids having to add it manually when you debug

* Add a target to print all variables in the makefile

* Fix the src_tables target

typos one s too many...

* Add a makefile variable to run tools in debug mode

Only ebook for now.

* Make default build the serif version of pdf

This is what the documentation said but both serif and sans were built

* Explicit serif in makefile and flattens rules

We had default (serif) and sans, better we have target named after their
fonts family

Flatten them as well so we can build ebooks or sans serif only as we
wish.

Simplified rules tree before:
-----------------------------
all/ bake
    release_serif
        build_pdf
            build_serif_pdf
                book_serif/book.pdf
            build_sans_serif_pdf
                book_sans_serif/book_sans_serif.pdf
        build_ebook
             build_serif_ebook
                epub/book.epub
                    epub/book.mobi
                    epub/book.azw3
             build_sans_serif_ebook
                epub/book_sans_serif.epub
                    epub/book_sans_serif.mobi
                    epub/book_sans_serif.azw3
    release_sans_serif
        build_sans_serif_pdf
            book_sans_serif/book_sans_serif.pdf
        build_sans_serif_ebook
            epub/book_sans_serif.epub
                epub/book_sans_serif.mobi
                epub/book_sans_serif.azw3

Simplified rules tree now:
--------------------------
all: bake
bake:
	release_serif
        build_serif_pdf
            book_serif/book.pdf
        build_serif_ebook:
            epub/book.epub
                epub/book.mobi
                epub/book.azw3
	release_sans_serif
        build_sans_serif_pdf
            book_sans_serif/book_sans_serif.pdf
        build_sans_serif_ebook
            epub/book_sans_serif.epub
                epub/book_sans_serif.mobi
                epub/book_sans_serif.azw3

build_pdf:
    build_serif_pdf
    build_sans_serif_pdf
build_ebook:
    build_serif_ebook
    build_sans_serif_ebook

release_serif:
    build_serif_pdf
    build_serif_ebook

release_sans_serif:
    build_sans_serif_pdf
    build_sans_serif_ebook

* Explicit the dependency on TikZ figures

latexmk figured that out but better if makefile is aware of it as well
2023-06-26 16:03:53 +02:00
cedounet
0c2fb17439 Ebooks build (#121)
* Use kindlegen for Kindle formats

.mobi and .azw3 are now built directly from .epub saving a few latex
runs, and double build of .mobi.

* Factorize amkefile rules and change coding gudelines

Simplify with a single rule for both serif and sans-serif

several makefiles are that way..
    - variables lower-case
    - commands/tools upper-case

* Simplify cleaning rules as per new rules

the directory structure has changed, so that shall change as well
2023-06-12 16:19:15 +02:00
cedounet
ca43ef0bd9 Improve typography (#120)
* Add unbreakable space before a reference or a citation

avoids ref to be put on next line or page...

* Add unbreakable space between I and verb

* Remove spacing before footnotes

Also moved it before the final sentence dots in many cases... might need
a review of what is best.  But this is a safe default choice from an
esthetic point of view.

* Improve footnotes and punctuations

Reverse order/kerning especially with sans-serif version.

* Remove manual enumerate

* Fix wording in a citation.

Reads better that way and is shorter.

* Use emph instead of italics

1) Markup semantic not style
2) Will deal with various level of empahasis
3) Was a mix of \it and \textit

* Fix usage of quotes

Also replaced some of then by \emph as it is (IMHO) more visually
pleasant.

* Captitalize before reference

* Correct dashes length

see here:
https://www.merriam-webster.com/words-at-play/em-dash-en-dash-how-to-use

* Remove space before label and homogenize caption

Apparently it can create a wrong reference, if notthing else shuts
texcheck up and cost nothing... so let's do it.

While at it adding a dot at the end of each caption.

* Add missing empty line before signature in preface

* Add a static checker target to makefile

Shall help prevent adding mistakes in new versions
2023-06-12 09:12:22 +02:00
cedounet
b734aa27f0 Fix typos in README (#118) 2023-06-06 22:31:37 +02:00
cedounet
e451a47d55 improve makefiles (#113)
* Make headrow in tables bold

* Simplify tables markup

- Markup is definitely simpler.
- Will not be built separately in a pdf anymore.
- Fixed some typo as well
- Relatively coherent look
- Can be better, some sizes are relatively arbitrary

* Remove horizontal separation inside tables

Not very nice if you ask me..

* Fix some tables for the ebook

The alignement trick to have nicely alignment on = sign or on unit (g)
used broke the html. Reverting to a less optimal version on pdf while
not breaking the html.

* Simplify table for html output

* Revert "Simplify table for html output"

This reverts commit f85d65adb7.

* Revert pancake table

This way it builds ebook correctly.

* Use latexmk and dedicated build_directory

- Generic rule for building pdf from tex
- build the book in its own directory
- do not clean before

* Make accessible pdf a command line option

* Simplify accessible version generation

using the option in book.tex instead of copying files around.
TODO: figures/Tkiz still are with serif.

* Specify some dependencies as order only

We don't want to trigger a rebuild everytime the directory timestamp
changes

* Remove force rebuild

* Fix dependencies handling

- Explicit some dependencies
- Ebook must be handled manually as we don't have latexmk working with
  latexmk or not sure how to do it...

* Improve clean

- Use latexmk to clean where possible
- clean the sans-serif as well
- failing rm will output a non-stopping error now

* Cleanup and comment makefile

For clarity, also move things around

* Add an mrproper target

clean now only removes intermediate files, keeps pdf and ebook in there.
Mr proper will remove evrything

* Add dependency of figures for ebook

* Add default rules you expect

make will build the pdf
make all will build all

* Add a make help command

Gives list of useful targets and their action

* Use latexmk to build TikZ pictures

* Use latexmk for building ebooks

* Let latexmk handle dependencies

would get it wrong otherwise...

* Add rule for sans serif ebook

* Add dependencies on TikZ figures for ebooks

* add mk4 file for the sans_serif version of ebook

symlink to the other one as they should be the same.

* Reorder the makefile variables declaration

Looks like I did not fully understood how it works..

Also added some PHONY targets and comments

* Add missing actions in clean target

Some file got forgotten... clean the makefile as well.

* Split the clean in a clean ebook section

* Clean the ebook before building the pdf

Not idel but I have no idea how to have the intermediate files in
another directory with tex4ebook
2023-06-06 17:45:57 +02:00
cedounet
50bf7f1de4 Nicer tables episode II (#111)
* Make headrow in tables bold

* Simplify tables markup

- Markup is definitely simpler.
- Will not be built separately in a pdf anymore.
- Fixed some typo as well
- Relatively coherent look
- Can be better, some sizes are relatively arbitrary

* Remove horizontal separation inside tables

Not very nice if you ask me..

* Fix some tables for the ebook

The alignement trick to have nicely alignment on = sign or on unit (g)
used broke the html. Reverting to a less optimal version on pdf while
not breaking the html.

* Simplify table for html output

* Revert "Simplify table for html output"

This reverts commit f85d65adb7.

* Revert pancake table

This way it builds ebook correctly.
2023-06-03 00:02:39 +02:00
Hendrik Kleinwaechter
0d1602cc17 Revert "Nicer/Simpler tables (#107)"
This reverts commit 037ae6d7fd.
2023-06-01 18:49:38 +02:00
Hendrik Kleinwaechter
6901701f86 Fix docker build (#110) 2023-06-01 18:49:07 +02:00
Hendrik Kleinwaechter
0ce7960b7a Hardcover version of book (#109)
This adds information on the upcoming hardcover version of the book.
2023-06-01 16:22:36 +02:00
Hendrik Kleinwaechter
916b610a53 Fix images not displaying (#108) 2023-06-01 16:02:09 +02:00
cedounet
037ae6d7fd Nicer/Simpler tables (#107)
* Make headrow in tables bold

* Simplify tables markup

- Markup is definitely simpler.
- Will not be built separately in a pdf anymore.
- Fixed some typo as well
- Relatively coherent look
- Can be better, some sizes are relatively arbitrary

* Remove horizontal separation inside tables

Not very nice if you ask me..
2023-06-01 14:38:37 +02:00
John Moon
f0a3deaac3 Fix typo in sourdough-starter-types.tex (#104)
"must" -> "most"
2023-06-01 14:26:26 +02:00
Hanso707
85b1acc3b6 Update sourdough-starter.tex (#106)
Fixed 'typo'
2023-06-01 14:26:06 +02:00
Hendrik Kleinwaechter
5412aa6e50 Ebook improvements (#103)
* Ebook improvements

Removes fixed height and width from the resulting HTML and adds an
additional css for the ebook formats.

* Update gitignore

* Strip tags
2023-05-26 13:35:04 +02:00
Hendrik Kleinwaechter
61c33e4b60 Spelling fixes + Improvements
Thanks again to Adam Carter for sending me the suggestions!
2023-05-25 16:07:11 +02:00
Hendrik Kleinwaechter
17d87c9af2 Revert "Fixed no such file error when running docker via sudo (#88)"
This reverts commit d2af29b09b.
2023-05-25 14:36:25 +02:00
Hendrik Kleinwaechter
c98f4fa74d Fix missing step in flow chart (#102)
We were missing one step in the starter readiness check. This fixes #100.
2023-05-25 13:47:10 +02:00
cedounet
77d3a9c75b Improve the look of tables (#99)
In order tho make the tables look better in document:
    1) Remove the vertical separation
    2) Add different width for top/mid/bottom rules
    3) Center them in the page

Co-authored-by: Cédric Andrieu <cedric@cirrus.com>
2023-05-25 13:36:30 +02:00
Neil Trodden
ca92125df8 Various typos (#98)
* fix: ✏️ and -> at

* fix: ✏️ redundant of
2023-05-22 09:31:41 +02:00