[ANN] bookly:0.1.0

Showcase
,
1

I am happy to share with you the first release of bookly, which is a Typst template designed for writing academic documents such as theses, French habilitations, or scientific books. It provides a structured format that adheres to academic standards, making it easier for authors to focus on content rather than formatting.

Main features

Themes: “classic”, “modern”, “fancy”
Language support: English and French
Font customization: Body and math fonts can be customized
Environments: front-matter, main-matter, appendix, back-matter
Outlines: tableofcontents, listoffigures, listoftables, minitoc
Part and chapter definition: part, chapter, chapter-nonum

Note: The chapters can be also written using the Typst standard markup syntax.

To see all the features available, a manual is available on my github repo.

Helper functions

  • Subfigures - based on the subpar package

    #subfigure(
    figure(image("image1.png"), caption: []),
    figure(image("image2.png"), caption: []), <b>,
    columns: (1fr, 1fr),
    caption: [Figure title],
    label: <fig:subfig>,
)

  • Equations

    • Boxed equations

      $
    #boxeq[$p(A|B) prop p(B|A) space p(A)$]
$

    • Unnumbered equations

      #nonumeq[$integral_0^1 f(x) dif x = F(1) - F(0)$]

    • Subequation numbering based on the equate package

  • Information boxes

    • #info-box for remarks
    • #tip-box for tips
    • #important-box for important notes
    • proof-box for proofs
    • question-box for questions
    • custom-box for user defined boxes

  • book-title-page for defining the title page of a book

  • thesis-title-page for defining the title page of a thesis

  • back-cover for defining the back cover of a book

As a final word, I am currently working on the next version of the template. In the next release, tufte layout will be added. I am also refactoring the code to easily define and use custom themes.

2 Likes
2

[Pre-ANN] bookly:v1.0.0

I have just submitted a PR to release the v1 of bookly . This new release marks the point at which bookly is considered feature-complete, hence the version number. The API won’t evolve too much in the next release. It can thus be considered as stable. This release introduces a number of new features, the most important of which are:

  • Theming refactoring, which enables custom themes to be defined in a user-friendly manner. So, PRs are welcome to add new themes.
  • tufte layout: Inspired by the works of Edward Tufte, this layout is characterised by wide margins that can be used for side notes, figures and other elements. It comes with several functions: sidenote , sidefigure , sidecite , fullfigure and fullwidth.
  • A new theme, orly , which mimics the style of O’Reilly books.
3 Likes