Add Template Tutorial (#16)

* add template tutorial

* Add Logo to front page

* formatting

* Apply suggestions from code review

Co-authored-by: Darius Peters <[email protected]>

* fix checks failing

* fix 2

---------

Co-authored-by: Markus Hofbauer <[email protected]>

Author: dariusptrs

.md-link-config.json

@@ -6,5 +6,15 @@
     {
       "pattern": "^http://"
     }
+  ],
+  "replacementPatterns": [
+    {
+      "pattern": "^/",
+      "replacement": "{{BASEURL}}/"
+    },
+    {
+      "pattern": "/img/",
+      "replacement": "/docs/img/"
+    }
   ]
 }

README.md

@@ -1,4 +1,7 @@
-# [LaTeX4Ei](http://latex4ei.de)
+<h1>
+    <img src="/img/Logo.png" width="100" style="vertical-align: middle; margin-right: 10px;">
+    <a href="http://latex4ei.de" style="color: currentColor; text-decoration: none;">LaTeX4Ei</a>
+</h1>
 
 Mitschriften und Formelsammlungen in LaTeX für Elektro- und Informationstechnik (TUM).
 

docs/TEMPLATE.md

@@ -0,0 +1,76 @@
+# ![CheatsheetTemplate](/img/CheatsheetTemplate.png)
+
+The [**LaTeX4Ei Template**](https://github.com/latex4ei/CheatsheetTemplate) is the solution for writing beautiful cheat sheets. In this section we explain how to get started using our template.
+
+## Example
+
+Here is our documentation PDF that demonstrates the template’s output:
+
+<iframe src="https://latex4ei.github.io/latex4ei-packages/LaTeX4EI-Template-Documentation.pdf" style="width: 100%; height: 510px; aspect-ratio: 297 / 210;"
+  frameborder="0">
+  This browser does not support PDFs. Please download the PDF <a href="https://latex4ei.github.io/latex4ei-packages/LaTeX4EI-Template-Documentation.pdf">here</a>.
+</iframe>
+
+______________________________________________________________________
+
+## Using the Template
+
+### 1. Setting Up Your Repository
+
+1. **Create Your Repository:**
+   Click the **"Use this template"** button on our [CheatsheetTemplate](https://github.com/latex4ei/CheatsheetTemplate) GitHub repository to create a new repository. Alternatively, you can clone the repository.
+
+1. **Download the Required Package:**
+   To compile locally, you must have the latest LaTeX4Ei package. Get it from:
+   [https://github.com/latex4ei/latex4ei-packages/releases](https://github.com/latex4ei/latex4ei-packages/releases)
+
+1. **Place the Package:**
+   Unzip `latex4ei.zip` (from the package download) and move the entire `latex4ei` folder into the root of your repository.
+
+If you want to **permanently install** our package, copy the `latex4ei` folder into your TeX distribution directory.
+
+- **Windows**
+
+  ```
+   Copy files to C:\texlive\XXXX\texmf-dist\tex\latex\latex4ei
+  ```
+
+- **Linux**
+
+  ```
+  sudo cp -r latex4ei /usr/share/texlive/texmf-dist/tex/latex/latex4ei
+  sudo mktexlsr
+  ```
+
+- **Mac OS X**
+
+  ```
+  cp -r latex4ei /usr/local/texlive/texmf-local/tex/latex/latex4ei
+  ```
+
+### 2. Update Environment (if using GitHub Actions)
+
+1. **Rename Your File:**  Rename the provided `CheatsheetTemplate.tex` file to exactly match the name of your repository. This ensures proper integration with our build process.
+
+1. **Update Build Files:**
+   Follow these steps to automatically update the build files:
+
+   1. Go to your repository on GitHub.
+   1. Click on the **Actions** tab.
+   1. Locate and trigger the **"Update README and LaTeX Build File"** action.
+
+This action automatically updates your README and the CMake build file with your repository’s name, ensuring your build configuration is set up correctly.
+
+### 3. Compile Your Cheat Sheet
+
+Now you can start adding content to your `.tex` file. You can compile your document:
+
+- **Locally:** With the `latex4ei` folder in your repository root, compile using your preferred LaTeX compiler (e.g., `pdflatex`).
+
+- **Via GitHub Actions:** When you push your changes, our GitHub action will automatically compile your cheat sheet. The generated PDF is available in the `gh-pages` branch or as an artifact of the workflow run.
+
+______________________________________________________________________
+
+## Questions?
+
+For questions or contributions, visit our [GitHub](https://github.com/latex4ei) or contact us at [[email protected]](mailto:[email protected]).

docs/img/CheatsheetTemplate.png

@@ -26,9 +26,10 @@ plugins:
 
 nav:
   - Home: README.md
+  - Template: TEMPLATE.md
+  - Wie kann ich helfen: CONTRIBUTING.md
   - TEX4TUM: http://tex4tum.de
   - Über uns: ABOUT.md
-  - Wie kann ich helfen: CONTRIBUTING.md
   - Kontakt: CONTACT.md
 
 extra_css: