initial commit

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-publisher 
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,25 @@
+# Cache & temp
+__pycache__
+.pub_blog_temp
+.pub_min_cache
+.ruff_cache
+.pytest_cache
+.DS_Store
+
+# Project specific
+.obsidian/
+.trash/
+
+# Logs
+*_mkdocs_build.log
+*_mkdocs_debug.zip
+
+# Other
+.env
+.idea
+.venv
+dist
+
+node_modules
+sandbox*
+docs_template

docs/01-home.md

@@ -0,0 +1,10 @@
+---
+title: Home
+slug: 01-home
+description: Example Publisher for MkDocs Site
+---
+
+# Welcome to Sample Publisher for MkDocs Site
+
+For full documentation visit [Publisher for MkDocs](https://mkdocs-publisher.github.io/).
+

docs/02-Blog/README.md

@@ -0,0 +1,4 @@
+---
+title: Blog
+slug: blog
+---

docs/02-Blog/first-post.md

@@ -0,0 +1,17 @@
+---
+title: First Blog Post
+slug: first-post
+date: 2024-08-10 12:02:00
+categories: cat1, cat2
+tags: tag1, tag2
+---
+
+### Lorem Ipsum
+
+
+"Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..."
+"There is no one who loves pain itself, who seeks after it and wants to have it, simply because it is pain..."
+
+<!-- more -->
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum tempus tellus nec mauris bibendum ultrices. Sed et ipsum scelerisque, elementum lacus id, faucibus erat. Donec tempus dui risus. Duis elementum et leo ac mattis. Fusce a rutrum velit, et vestibulum tortor. Aliquam erat volutpat. Donec fermentum tincidunt consequat. Vivamus eleifend tellus sed orci feugiat, eu lobortis orci auctor.

docs/03-Narkdown-Examples/Advanced formatting syntax.md

@@ -0,0 +1,192 @@
+---
+aliases:
+  - Advanced Markdown
+---
+Learn how to add advanced formatting syntax to your notes.
+
+## Tables
+
+You can create table using vertical bars (`|`) and hyphens (`-`). Vertical bars separate columns, and hyphens define the column header.
+
+```md
+| First name | Last name |
+| ---------- | --------- |
+| Max        | Planck    |
+| Marie      | Curie     |
+```
+
+| First name | Last name |
+| ---------- | --------- |
+| Max        | Planck    |
+| Marie      | Curie     |
+
+The vertical bars on either side of the table are optional.
+
+Cells don't need to be perfectly aligned with the columns. Each header row must have at least two hyphens.
+
+```md
+First name | Last name
+-- | --
+Max | Planck
+Marie | Curie
+```
+
+### Format content within a table
+
+You can use [[basic formatting syntax]] to style content within a table.
+
+| First column       | Second column                           |
+| ------------------ | --------------------------------------- |
+| [[Internal links]] | Link to a file _within_ your **vault**. |
+| [[Embed files]]    | ![[Engelbart.jpg\|100]]                 |
+
+> [!note] Vertical bars in tables
+> If you want to use [[aliases]], or to [[Basic formatting syntax#External images|resize an image]] in your table, you need to add a `\` before the vertical bar.
+>
+> ```md
+> First column | Second column
+> -- | --
+> [[Basic formatting syntax\|Markdown syntax]] | ![[Engelbart.jpg\|200]]
+> ```
+>
+> First column | Second column
+> -- | --
+> [[Basic formatting syntax\|Markdown syntax]] | ![[Engelbart.jpg\|200]]
+
+You can align text to the left, right, or center of a column by adding colons (`:`) to the header row.
+
+```md
+Left-aligned text | Center-aligned text | Right-aligned text
+:-- | :--: | --:
+Content | Content | Content
+```
+
+Left-aligned text | Center-aligned text | Right-aligned text
+:-- | :--: | --:
+Content | Content | Content
+
+## Diagram
+
+You can add diagrams and charts to your notes, using [Mermaid](https://mermaid-js.github.io/). Mermaid supports a range of diagrams, such as [flow charts](https://mermaid.js.org/syntax/flowchart.html), [sequence diagrams](https://mermaid.js.org/syntax/sequenceDiagram.html), and [timelines](https://mermaid.js.org/syntax/timeline.html).
+
+> [!tip]
+> You can also try Mermaid's [Live Editor](https://mermaid-js.github.io/mermaid-live-editor) to help you build diagrams before you include them in your notes.
+
+To add a Mermaid diagram, create a `mermaid` [[Basic formatting syntax#Code blocks|code block]].
+
+````md
+```mermaid
+sequenceDiagram
+    Alice->>+John: Hello John, how are you?
+    Alice->>+John: John, can you hear me?
+    John-->>-Alice: Hi Alice, I can hear you!
+    John-->>-Alice: I feel great!
+```
+````
+
+```mermaid
+sequenceDiagram
+    Alice->>+John: Hello John, how are you?
+    Alice->>+John: John, can you hear me?
+    John-->>-Alice: Hi Alice, I can hear you!
+    John-->>-Alice: I feel great!
+```
+
+````md
+```mermaid
+graph TD
+
+Biology --> Chemistry
+```
+````
+
+```mermaid
+graph TD
+
+Biology --> Chemistry
+```
+
+### Linking files in a diagram
+
+You can create [[internal links]] in your diagrams by attaching the `internal-link` [class](https://mermaid.js.org/syntax/flowchart.html#classes) to your nodes.
+
+````md
+```mermaid
+graph TD
+
+Biology --> Chemistry
+
+class Biology,Chemistry internal-link;
+```
+````
+
+```mermaid
+graph TD
+
+Biology --> Chemistry
+
+class Biology,Chemistry internal-link;
+```
+
+> [!note]
+> Internal links from diagrams don't show up in the [[Graph view]].
+
+If you have many nodes in your diagrams, you can use the following snippet.
+
+````md
+```mermaid
+graph TD
+
+A[Biology]
+B[Chemistry]
+
+A --> B
+
+class A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z internal-link;
+```
+````
+
+This way, each letter node becomes an internal link, with the [node text](https://mermaid.js.org/syntax/flowchart.html#a-node-with-text) as the link text.
+
+> [!note]
+> If you use special characters in your note names, you need to put the note name in double quotes.
+>
+> ```
+> class "⨳ special character" internal-link
+> ```
+>
+> Or, `A["⨳ special character"]`.
+
+For more information about creating diagrams, refer to the [official Mermaid docs](https://mermaid.js.org/intro/).
+
+## Math
+
+You can add math expressions to your notes using [MathJax](http://docs.mathjax.org/en/latest/basic/mathjax.html) and the LaTeX notation.
+
+To add a MathJax expression to your note, surround it with double dollar signs (`$$`).
+
+```md
+$$
+\begin{vmatrix}a & b\\
+c & d
+\end{vmatrix}=ad-bc
+$$
+```
+
+$$
+\begin{vmatrix}a & b\\
+c & d
+\end{vmatrix}=ad-bc
+$$
+
+You can also inline math expressions by wrapping it in `$` symbols.
+
+```md
+This is an inline math expression $e^{2i\pi} = 1$.
+```
+
+This is an inline math expression $e^{2i\pi} = 1$.
+
+For more information about the syntax, refer to [MathJax basic tutorial and quick reference](https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference).
+
+For a list of supported MathJax packages, refer to [The TeX/LaTeX Extension List](http://docs.mathjax.org/en/latest/input/tex/extensions/index.html).