From 86028bf2a78ff2f3c653e9fadc78d8a354cdee18 Mon Sep 17 00:00:00 2001 From: Noah Pombas Date: Thu, 4 Dec 2025 17:04:21 +0100 Subject: [PATCH] Added an Overview --- docs/index.md | 31 +++++++++- docs/projects/guides/git.md | 4 ++ docs/projects/guides/markdown.md | 66 ++++++++++++++++++++++ docs/projects/lerndoku-template/mkdocs.yml | 9 --- docs/projects/servicenow/mkdocs.yml | 9 --- 5 files changed, 99 insertions(+), 20 deletions(-) create mode 100644 docs/projects/guides/git.md create mode 100644 docs/projects/guides/markdown.md delete mode 100644 docs/projects/lerndoku-template/mkdocs.yml delete mode 100644 docs/projects/servicenow/mkdocs.yml diff --git a/docs/index.md b/docs/index.md index d6cd44e..bf75ed2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,2 +1,29 @@ -# Welcome to Noah's control room. -# no lang \ No newline at end of file +# Noah's Control Room + +Welcome to Noah's project documentation control room. Here you can quickly access each project and its guides. + +--- + +## Projects + +### 1. [LernDoku Template](projects/lerndoku-template/docs/index.md) +- **Description:** Base template for learning documentation. +- **Main files:** + - [Getting Started](projects/lerndoku-template/docs/getting-started.md) + - [Guides](projects/lerndoku-template/docs/guides/git.md) + - [Markdown Tips](projects/lerndoku-template/docs/guides/markdown.md) + +### 2. [ServiceNow](projects/servicenow/docs/index.md) +- **Description:** Project documentation and guides for ServiceNow. +- **Main files:** + - [Getting Started](projects/servicenow/docs/getting-started.md) + - [Guides](projects/servicenow/docs/guides/git.md) + - [Markdown Tips](projects/servicenow/docs/guides/markdown.md) + +--- + +## Quick Links + +- [Home](index.md) +- [English Version](en/index.md) +- [Deutsch Version](de/index.md) diff --git a/docs/projects/guides/git.md b/docs/projects/guides/git.md new file mode 100644 index 0000000..c231125 --- /dev/null +++ b/docs/projects/guides/git.md @@ -0,0 +1,4 @@ +# GIT + +### What is git +### Commands \ No newline at end of file diff --git a/docs/projects/guides/markdown.md b/docs/projects/guides/markdown.md new file mode 100644 index 0000000..d3d7f64 --- /dev/null +++ b/docs/projects/guides/markdown.md @@ -0,0 +1,66 @@ +# Markdown Overview + +This page gives you a quick overview of the most common Markdown syntax used in MkDocs. + +--- + +### Headings + +``` +# H1 +## H2 +### H3 +``` + +### Text Formatting +``` +**bold** +*italic* +~~strikethrough~~ +`inline code` +``` +## Lists +### Unordered +``` +- Item 1 +- Item 2 + - Subitem +``` +### Ordered +``` +1. First +2. Second +3. Third +``` +### Code Blocks +``` +
 ```bash echo "Hello" ``` 
+``` +### Links & Images +``` +[Link text](https://example.com) + +![Alt text](img/example.png) +``` +### Blockquotes +``` +> This is a quote. +``` +### Tables +``` +| Column A | Column B | +|----------|----------| +| Value 1 | Value 2 | +``` +### Horizontal Rule +```---``` + +### Admonitions +``` +!!! note + This is a note. +``` + +### More + +``` For full syntax see: https://www.markdownguide.org/ ``` diff --git a/docs/projects/lerndoku-template/mkdocs.yml b/docs/projects/lerndoku-template/mkdocs.yml deleted file mode 100644 index a43ee76..0000000 --- a/docs/projects/lerndoku-template/mkdocs.yml +++ /dev/null @@ -1,9 +0,0 @@ -site_name: Lehrlingsdoku -site_url: https://pombas_n.pages.psi.ch - -nav: - - Home: index.md - - Getting Started: getting-started.md - - Guides: - - Example Guide: guides/git.md - - Markdown Guide: guides/markdown.md diff --git a/docs/projects/servicenow/mkdocs.yml b/docs/projects/servicenow/mkdocs.yml deleted file mode 100644 index a43ee76..0000000 --- a/docs/projects/servicenow/mkdocs.yml +++ /dev/null @@ -1,9 +0,0 @@ -site_name: Lehrlingsdoku -site_url: https://pombas_n.pages.psi.ch - -nav: - - Home: index.md - - Getting Started: getting-started.md - - Guides: - - Example Guide: guides/git.md - - Markdown Guide: guides/markdown.md