Skip to content
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
21 changes: 21 additions & 0 deletions packages/preview/unofficial-eirb-report/0.1.1/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 floriandelage

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
130 changes: 130 additions & 0 deletions packages/preview/unofficial-eirb-report/0.1.1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Enseirb-Matmeca Typst Template for Reports
[![GitHub release](https://img.shields.io/github/v/release/floriandelage/unofficial-eirb-report)](https://github.com/floriandelage/unofficial-eirb-report/releases)

An unofficial [Typst](https://typst.app/) template for [Enseirb-Matmeca](https://enseirb-matmeca.bordeaux-inp.fr/fr)

*Disclaimer: This template is not affiliated with Enseirb-Matmeca.*

## Assets and trademarks

This package includes official branding assets from Enseirb-Matmeca / Bordeaux INP.

These assets are **not covered by the package license** and remain the property of their respective copyright holders.

- Enseirb-Matmeca branding guidelines and assets: https://enseirb-matmeca.bordeaux-inp.fr/fr/outils-de-communication-inp

Use of these assets is subject to the terms provided by the copyright holder.

<p align="center" style="margin-top:0px;">
<a href="docs/example.pdf">View example PDF output</a>
</p>

## Getting Started

1. **Font Installation (optional, but recommended)**
- The template uses [Linux Libertine](https://www.dafont.com/linux-libertine.font) for the main text
- The template also uses [JetBrains Mono](https://www.jetbrains.com/lp/mono/) for code blocks and raw text
- There is a fallback system that will use "New Computer Modern", the default Typst font

2. **Configure the template**
- Edit the template parameters in `main.typ` to set your details:
```typ
#show: template.with(
sector: "Filière Informatique",
document-type: "Rapport de Projet",

title: "Implémentation d'un modèle de rapport académique",

authors: (
(name: "Alexandrine Mercier", email: "alexandrine.mercier@enseirb.fr"),
(name: "Narcisse Fay", email: "narcisse.fay@enseirb.fr"),
(name: "Johanne Reyer", email: "johanne.reyer@enseirb.fr"),
(name: "Modestine Lapointe", email: "modestine.lapointe@enseirb.fr"),
),
author-columns: 2,

advisers: (
(name: "Adelphe Félix", email: "adelphe.felix@enseirb.fr"),
),
adviser-columns: 1,

date: "Mai 2025",
abstract: include "sections/0-abstract.typ",
)
```

3. **Write your content**
- The sections are split into files for organisation (see the `sections` folder)
- If you add sections, don't forget to add them in the `main.typ` file

4. **Compile your document**
```bash
typst compile main.typ
```
- Or watch for changes and recompile automatically:
```bash
typst watch main.typ
```

## Getting Started with Typst

### Resources
- [Typst for LaTeX users](https://typst.app/docs/guides/guide-for-latex-users/)
- [Official Typst Documentation](https://typst.app/docs)
- [Typst Examples Book](https://sitandr.github.io/typst-examples-book/book/)

### Installation
> **Note:** Typst also provides an online editor at [typst.app](https://typst.app/)

1. **Install Typst**
- [Typst GitHub Repository](https://github.com/typst/typst?tab=readme-ov-file#installation)

2. **Editor Integration**
- [TinyMist Extension](https://github.com/Myriad-Dreamin/tinymist?tab=readme-ov-file#installation) for VSCode, NeoVim, etc.

## For Internship reports

You can add the company logo of your internship, which will be placed next to the school logo in the title page and the footer, like that:

```typ
#show: template.with(
company-logo: image("path_to_company_logo.png", width: 50%),
)
```

You can also override the school logo if you want to by using `school-logo`.

Finally, you can also disable the abstract by setting it to `none`.

## Working with References

### Subfigures

This template includes the package [subpar](https://typst.app/universe/package/subpar/), which allows you to easily create and reference subfigures, a feature that is not natively supported in Typst.

You can create subfigures and label them like this:

```typst
#import "@preview/unofficial-eirb-report:0.1.1": subfig

#subfig(
figure(image("./assets/figure.png"), caption: [Première sous-figure]),
<fig-a>,
figure(image("./assets/figure.png"), caption: [Seconde sous-figure]),
<fig-b>,
columns: (1fr, 1fr),
caption: [Une figure contenant deux sous-figures.],
label: <fig-full>,
)
```

### Bibliography
- Add references to `bib.yaml`
- Reference in text using `@citation_key` or `#ref(<citation_key>)`
- The bibliography is generated automatically at the end fo the document
- Supports articles, books, proceedings, web resources, and more

## Credits
This template is built on the foundation provided by [onyx-itu-unofficial](https://github.com/FrederikBertelsen/onyx-itu-unofficial) by FrederikBertelsen.
The original work has been expanded with additional features, French language support,
and Enseirb-Matmeca styling.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading