From 261e023d7edb7ad991fe9fd29c761d5b5bca0539 Mon Sep 17 00:00:00 2001 From: Max1Truc <26603929+Max1Truc@users.noreply.github.com> Date: Sun, 23 Mar 2025 17:53:51 +0100 Subject: [PATCH] switch to mdbook --- .github/workflows/gh-pages.yml | 29 +++++++++++++++++++++++++++++ .gitignore | 1 + README.md | 10 +++++++--- book.toml | 6 ++++++ src/SUMMARY.md | 3 +++ logo.jpg => src/logo.jpg | Bin src/presentation.md | 7 +++++++ 7 files changed, 53 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/gh-pages.yml create mode 100644 .gitignore create mode 100644 book.toml create mode 100644 src/SUMMARY.md rename logo.jpg => src/logo.jpg (100%) create mode 100644 src/presentation.md diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 0000000..67c01b1 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,29 @@ +name: github pages + +on: + push: + branches: + - main + pull_request: + +jobs: + deploy: + runs-on: ubuntu-24.04 + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + steps: + - uses: actions/checkout@v2 + + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v2 + with: + mdbook-version: 'latest' + + - run: mdbook build + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.ref == 'refs/heads/main' }} + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./book diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +book diff --git a/README.md b/README.md index 5cd6ec6..173bbeb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ -![La fameuse mascotte du langage Rust, Ferris le crabe, se dessine en blanc sur fond orange. Le nom de l'association epi.rs se pose à droite de Ferris, en Orange sur fond blanc.](logo.jpg) +# -Bienvenue sur le site de l'association de Rust d'étudiants de l'EPITA. +Bienvenue sur le site de l'association epi.rs, qui regroupe des étudiant.e.s du groupe IONIS autour du langage Rust. -🚧 Ce site est encore en construction, si vous souhaitez rejoindre l'association je vous invite à rejoindre notre serveur discord en attendant: https://discord.gg/akemH2D7yA +Ce livre est en cours de construction, et au format mdbook. + +## Contributions + +Avant de commencer, vous devriez savoir utiliser [Git](https://agripongit.vincenttunru.com/), [Markdown](https://www.markdownguide.org/basic-syntax/) et [mdbook](https://rust-lang.github.io/mdBook/). N'hésitez pas à rejoindre le serveur Discord pour nous demander un coup de main. diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..cffb63b --- /dev/null +++ b/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["epi.rs"] +language = "fr" +multilingual = false +src = "src" +title = "epi.rs" diff --git a/src/SUMMARY.md b/src/SUMMARY.md new file mode 100644 index 0000000..600f8c0 --- /dev/null +++ b/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Présentation](./presentation.md) diff --git a/logo.jpg b/src/logo.jpg similarity index 100% rename from logo.jpg rename to src/logo.jpg diff --git a/src/presentation.md b/src/presentation.md new file mode 100644 index 0000000..6ecee2c --- /dev/null +++ b/src/presentation.md @@ -0,0 +1,7 @@ +# Présentation + +Bienvenue sur le site de l'association de Rust d'étudiants de l'EPITA. + +🚧 Ce site est encore en construction, si vous souhaitez rejoindre l'association je vous invite à rejoindre notre serveur discord en attendant: + +![La fameuse mascotte du langage Rust, Ferris le crabe, se dessine en blanc sur fond orange. Le nom de l'association epi.rs se pose à droite de Ferris, en Orange sur fond blanc.](logo.jpg)