From 47614e3f235f0a47b0e3a2b4dbf0ede2cd7277b1 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 08:51:33 +0100 Subject: [PATCH 01/14] Color Switch, changed description. Signed-off-by: Noah Pombas --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 8abfd61..ddf5cd7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,7 +25,7 @@ theme: - scheme: slate toggle: icon: material/brightness-4 - name: Switch to light mode + name: Switch to light mode purple primary: purple accent: purple From d6a8b75b90f0a10b476a320e5f2cb9ad1a0e22e1 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 09:04:18 +0100 Subject: [PATCH 02/14] Added information to git guide --- docs/guides/git.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/guides/git.md b/docs/guides/git.md index c231125..febabbe 100644 --- a/docs/guides/git.md +++ b/docs/guides/git.md @@ -1,4 +1,8 @@ # GIT ### What is git -### Commands \ No newline at end of file +### Commands + + +#### git clone +##### Clone a Repo (remote -> local) \ No newline at end of file From 929559068ab131e1ec906cd93a0fb8bf9f98acdb Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 09:06:12 +0100 Subject: [PATCH 03/14] Trying to sign a commit --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index b4efa3a..c3fc71d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,7 +7,7 @@ Welcome to Noah's project documentation control room. Here you can quickly acces ## Guides ### 1. [Git](guides/git.md) -- **Description:** All useful git commands +- **Description:** All useful git commands. - **Main files:** - [Check it out](guides/git.md) From 8c823c7c19fd127ab84e2661b643dc870c4bc878 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 09:08:44 +0100 Subject: [PATCH 04/14] Git Guide Update --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index c3fc71d..f657b43 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ Welcome to Noah's project documentation control room. Here you can quickly acces ### 2. [Markdown](guides/markdown.md) -- **Description:** Markdown Syntax +- **Description:** Markdown Syntax. - **Main files:** - [Check it out](guides/markdown.md) From 17ee5d5e544dd10e9443baf1171471fd1bf4e3c7 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 09:16:35 +0100 Subject: [PATCH 05/14] removed a dot --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index f657b43..83addfe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,7 +23,7 @@ Welcome to Noah's project documentation control room. Here you can quickly acces ## Projects ### 1. [LernDoku Template](projects/lerndoku-template/getting-started.md) -- **Description:** Base template for learning documentation. +- **Description:** Base template for learning documentation - **Main files:** - [Getting Started](projects/lerndoku-template/getting-started.md) - [git clone](projects/lerndoku-template/docs/index.md) From 8d462c838b9edef519ce0f77fc774b04af1c9065 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 09:51:58 +0100 Subject: [PATCH 06/14] Finished the Git Guide --- docs/guides/git.md | 138 +++++++++++++++++++++++++++++++++++++++++++-- mkdocs.yml | 6 +- 2 files changed, 136 insertions(+), 8 deletions(-) diff --git a/docs/guides/git.md b/docs/guides/git.md index febabbe..a046825 100644 --- a/docs/guides/git.md +++ b/docs/guides/git.md @@ -1,8 +1,134 @@ -# GIT - -### What is git -### Commands +# Git -#### git clone -##### Clone a Repo (remote -> local) \ No newline at end of file +--- + +## Clone a repository +Copy an existing remote repository to your local machine. + +```bash +git clone +``` +Example: +```bash +git clone https://github.com/user/repo.git +``` + +--- + +## Pull changes from remote +Fetch and merge changes from a remote repository to your local branch. + +```bash +git pull +``` +Example: +```bash +git pull origin main +``` + +--- + +## Push changes to remote +Upload local commits to a remote repository. + +```bash +git push +``` +Example: +```bash +git push origin main +``` + +--- + +## Rebase branches +Reapply commits on top of another base tip. + +```bash +git rebase +``` +Example: +```bash +git rebase main +``` + +--- + +## Initialize a new repository +Create a new Git repository in the current directory. + +```bash +git init +``` + +--- + +## Manage remotes + +- **Add a remote:** +```bash +git remote add +``` + +- **Set/Update remote URL:** +```bash +git remote set-url +``` + +- **Remove a remote (e.g., origin):** +```bash +git remote remove origin +``` + +--- + +## Commit changes with GPG signature +Sign your commit with a GPG key. + +```bash +git commit -S -m "Your commit message" +``` +- `-S` → sign commit with GPG key +- `-m` → commit message + +--- + +## Notes +- Always ensure your branch is up-to-date before pushing: +```bash +git pull --rebase +``` +- Configure your GPG key once globally for signed commits: +```bash +git config --global user.signingkey +git config --global commit.gpgSign true +``` +- To check the configured remotes: +```bash +git remote -v +``` +- To see commit history: +```bash +git log --oneline --graph --all --decorate +``` +- Stage changes before committing: +```bash +git add +git add . # stage all changes +``` + +--- + +## Example Workflow + +```bash +git clone https://github.com/user/repo.git +cd repo +git checkout -b feature-branch +# make changes +git add . +git commit -S -m "Add new feature" +git pull --rebase origin main +git push origin feature-branch +``` diff --git a/mkdocs.yml b/mkdocs.yml index ddf5cd7..eb7e4cb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,7 @@ theme: name: material palette: - # Light mode + # Light mode purple - scheme: default toggle: icon: material/brightness-7 @@ -14,6 +14,7 @@ theme: primary: purple accent: purple + # Light mode blue - scheme: default toggle: icon: material/numeric-1-box @@ -21,7 +22,7 @@ theme: primary: blue accent: blue - # Dark mode + # Dark mode purple - scheme: slate toggle: icon: material/brightness-4 @@ -29,6 +30,7 @@ theme: primary: purple accent: purple + # Dark mode blue - scheme: slate toggle: icon: material/numeric-1-box From 656fae3f82b051559b09911e315f708eb72d950b Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 09:57:25 +0100 Subject: [PATCH 07/14] Updates git log Guide --- docs/guides/git.md | 30 +++++++----------------------- 1 file changed, 7 insertions(+), 23 deletions(-) diff --git a/docs/guides/git.md b/docs/guides/git.md index a046825..935d31b 100644 --- a/docs/guides/git.md +++ b/docs/guides/git.md @@ -95,40 +95,24 @@ git commit -S -m "Your commit message" --- ## Notes -- Always ensure your branch is up-to-date before pushing: -```bash -git pull --rebase -``` -- Configure your GPG key once globally for signed commits: -```bash -git config --global user.signingkey -git config --global commit.gpgSign true -``` - To check the configured remotes: ```bash git remote -v ``` - To see commit history: ```bash +# Those options only add Styling, git log --oneline --graph --all --decorate + +# Plain Text Log, +git log + ``` + - Stage changes before committing: ```bash git add git add . # stage all changes ``` ---- - -## Example Workflow - -```bash -git clone https://github.com/user/repo.git -cd repo -git checkout -b feature-branch -# make changes -git add . -git commit -S -m "Add new feature" -git pull --rebase origin main -git push origin feature-branch -``` +--- \ No newline at end of file From e9f75e28e0f99088a03a5e6ce5f30eca5a9504b9 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 10:08:07 +0100 Subject: [PATCH 08/14] Added Syntax highlightning to code blocks. --- mkdocs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index eb7e4cb..cb90acf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,6 +37,10 @@ theme: name: Blue primary: blue accent: blue +markdown_extensions: + - codehilite: + guess_lang: true + pygments_style: monokai extra_css: From 2cc50a0648cc57dd118a6ff66678795f726116b6 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 10:10:25 +0100 Subject: [PATCH 09/14] Installed syntax highlightning plugin --- .gitea/workflows/deploy-pages.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.gitea/workflows/deploy-pages.yml b/.gitea/workflows/deploy-pages.yml index 154a12f..b7d7291 100644 --- a/.gitea/workflows/deploy-pages.yml +++ b/.gitea/workflows/deploy-pages.yml @@ -15,10 +15,14 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 - - name: Build theme + - name: Install theme run: | /opt/python-env/bin/pip install mkdocs-material + - name: Install Syntax highlightning + run: | + /opt/python-env/bin/pip install pygments + - name: Build mkdocs run: | export TZ="Europe/Zurich" From 5f78238b550c2699ef98018fc76f0b0a31904ea8 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 10:13:48 +0100 Subject: [PATCH 10/14] replaced codehilite with pygments --- docs/guides/git.md | 32 ++++++++++++++++---------------- mkdocs.yml | 5 +---- 2 files changed, 17 insertions(+), 20 deletions(-) diff --git a/docs/guides/git.md b/docs/guides/git.md index 935d31b..10b37eb 100644 --- a/docs/guides/git.md +++ b/docs/guides/git.md @@ -6,11 +6,11 @@ ## Clone a repository Copy an existing remote repository to your local machine. -```bash +```shell git clone ``` Example: -```bash +```shell git clone https://github.com/user/repo.git ``` @@ -19,11 +19,11 @@ git clone https://github.com/user/repo.git ## Pull changes from remote Fetch and merge changes from a remote repository to your local branch. -```bash +```shell git pull ``` Example: -```bash +```shell git pull origin main ``` @@ -32,11 +32,11 @@ git pull origin main ## Push changes to remote Upload local commits to a remote repository. -```bash +```shell git push ``` Example: -```bash +```shell git push origin main ``` @@ -45,11 +45,11 @@ git push origin main ## Rebase branches Reapply commits on top of another base tip. -```bash +```shell git rebase ``` Example: -```bash +```shell git rebase main ``` @@ -58,7 +58,7 @@ git rebase main ## Initialize a new repository Create a new Git repository in the current directory. -```bash +```shell git init ``` @@ -67,17 +67,17 @@ git init ## Manage remotes - **Add a remote:** -```bash +```shell git remote add ``` - **Set/Update remote URL:** -```bash +```shell git remote set-url ``` - **Remove a remote (e.g., origin):** -```bash +```shell git remote remove origin ``` @@ -86,7 +86,7 @@ git remote remove origin ## Commit changes with GPG signature Sign your commit with a GPG key. -```bash +```shell git commit -S -m "Your commit message" ``` - `-S` → sign commit with GPG key @@ -96,11 +96,11 @@ git commit -S -m "Your commit message" ## Notes - To check the configured remotes: -```bash +```shell git remote -v ``` - To see commit history: -```bash +```shell # Those options only add Styling, git log --oneline --graph --all --decorate @@ -110,7 +110,7 @@ git log ``` - Stage changes before committing: -```bash +```shell git add git add . # stage all changes ``` diff --git a/mkdocs.yml b/mkdocs.yml index cb90acf..ba12b51 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,10 +37,7 @@ theme: name: Blue primary: blue accent: blue -markdown_extensions: - - codehilite: - guess_lang: true - pygments_style: monokai + extra_css: From e03708d1afeb755424f059fcce03937c1dcb1669 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 10:16:05 +0100 Subject: [PATCH 11/14] Added $ for shell commands --- docs/guides/git.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/guides/git.md b/docs/guides/git.md index 10b37eb..5145679 100644 --- a/docs/guides/git.md +++ b/docs/guides/git.md @@ -7,11 +7,11 @@ Copy an existing remote repository to your local machine. ```shell -git clone +$ git clone ``` Example: ```shell -git clone https://github.com/user/repo.git +$ git clone https://github.com/user/repo.git ``` --- @@ -20,11 +20,11 @@ git clone https://github.com/user/repo.git Fetch and merge changes from a remote repository to your local branch. ```shell -git pull +$ git pull ``` Example: ```shell -git pull origin main +$ git pull origin main ``` --- @@ -33,11 +33,11 @@ git pull origin main Upload local commits to a remote repository. ```shell -git push +$ git push ``` Example: ```shell -git push origin main +$ git push origin main ``` --- @@ -46,11 +46,11 @@ git push origin main Reapply commits on top of another base tip. ```shell -git rebase +$ git rebase ``` Example: ```shell -git rebase main +$ git rebase main ``` --- @@ -59,7 +59,7 @@ git rebase main Create a new Git repository in the current directory. ```shell -git init +$ git init ``` --- @@ -68,17 +68,17 @@ git init - **Add a remote:** ```shell -git remote add +$ git remote add ``` - **Set/Update remote URL:** ```shell -git remote set-url +$ git remote set-url ``` - **Remove a remote (e.g., origin):** ```shell -git remote remove origin +$ git remote remove origin ``` --- @@ -87,7 +87,7 @@ git remote remove origin Sign your commit with a GPG key. ```shell -git commit -S -m "Your commit message" +$ git commit -S -m "Your commit message" ``` - `-S` → sign commit with GPG key - `-m` → commit message @@ -97,22 +97,22 @@ git commit -S -m "Your commit message" ## Notes - To check the configured remotes: ```shell -git remote -v +$ git remote -v ``` - To see commit history: ```shell # Those options only add Styling, -git log --oneline --graph --all --decorate +$ git log --oneline --graph --all --decorate # Plain Text Log, -git log +$ git log ``` - Stage changes before committing: ```shell -git add -git add . # stage all changes +$ git add +$ git add . # stage all changes ``` --- \ No newline at end of file From fc15d29ecc9dc0166972b038029803685ce894d9 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 10:19:17 +0100 Subject: [PATCH 12/14] removed $ for shell commands, and added new plugin --- docs/guides/git.md | 36 ++++++++++++++++++------------------ mkdocs.yml | 3 +++ 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/docs/guides/git.md b/docs/guides/git.md index 5145679..10b37eb 100644 --- a/docs/guides/git.md +++ b/docs/guides/git.md @@ -7,11 +7,11 @@ Copy an existing remote repository to your local machine. ```shell -$ git clone +git clone ``` Example: ```shell -$ git clone https://github.com/user/repo.git +git clone https://github.com/user/repo.git ``` --- @@ -20,11 +20,11 @@ $ git clone https://github.com/user/repo.git Fetch and merge changes from a remote repository to your local branch. ```shell -$ git pull +git pull ``` Example: ```shell -$ git pull origin main +git pull origin main ``` --- @@ -33,11 +33,11 @@ $ git pull origin main Upload local commits to a remote repository. ```shell -$ git push +git push ``` Example: ```shell -$ git push origin main +git push origin main ``` --- @@ -46,11 +46,11 @@ $ git push origin main Reapply commits on top of another base tip. ```shell -$ git rebase +git rebase ``` Example: ```shell -$ git rebase main +git rebase main ``` --- @@ -59,7 +59,7 @@ $ git rebase main Create a new Git repository in the current directory. ```shell -$ git init +git init ``` --- @@ -68,17 +68,17 @@ $ git init - **Add a remote:** ```shell -$ git remote add +git remote add ``` - **Set/Update remote URL:** ```shell -$ git remote set-url +git remote set-url ``` - **Remove a remote (e.g., origin):** ```shell -$ git remote remove origin +git remote remove origin ``` --- @@ -87,7 +87,7 @@ $ git remote remove origin Sign your commit with a GPG key. ```shell -$ git commit -S -m "Your commit message" +git commit -S -m "Your commit message" ``` - `-S` → sign commit with GPG key - `-m` → commit message @@ -97,22 +97,22 @@ $ git commit -S -m "Your commit message" ## Notes - To check the configured remotes: ```shell -$ git remote -v +git remote -v ``` - To see commit history: ```shell # Those options only add Styling, -$ git log --oneline --graph --all --decorate +git log --oneline --graph --all --decorate # Plain Text Log, -$ git log +git log ``` - Stage changes before committing: ```shell -$ git add -$ git add . # stage all changes +git add +git add . # stage all changes ``` --- \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index ba12b51..11f6b89 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,3 +59,6 @@ plugins: - en - de +markdown_extensions: + - pymdownx.superfences + - pymdownx.highlight \ No newline at end of file From 352c22922bb4e270e8b108cab926d2a46e54b2f9 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 10:22:45 +0100 Subject: [PATCH 13/14] Added support for emojis --- mkdocs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 11f6b89..a0103ea 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -61,4 +61,7 @@ plugins: markdown_extensions: - pymdownx.superfences - - pymdownx.highlight \ No newline at end of file + - pymdownx.highlight + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg From 12be99d5b730845090a8fd18fa2bf8932154d4b9 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Fri, 5 Dec 2025 10:24:56 +0100 Subject: [PATCH 14/14] Improved navigation --- mkdocs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index a0103ea..19f693a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,10 @@ site_url: https://pombas_n.pages.psi.ch theme: name: material + features: + - navigation.instant + - navigation.instant.prefetch + - navigation.instant.progress palette: # Light mode purple