From 44c8b96851d3bf19461a52624d75ce23f2711fdd Mon Sep 17 00:00:00 2001 From: AgedLace Date: Sat, 10 Aug 2024 14:59:09 -0400 Subject: [PATCH] initial commit --- .github/workflows/ci.yml | 29 ++ .gitignore | 25 ++ docs/01-home.md | 10 + docs/02-Blog/README.md | 4 + docs/02-Blog/first-post.md | 17 + .../Advanced formatting syntax.md | 192 +++++++++ .../Basic formatting syntax.md | 373 ++++++++++++++++++ .../Obsidian Flavored Markdown.md | 20 + docs/03-Narkdown-Examples/README.md | 3 + docs/For-Maq.md | 21 + docs/_assets/README.md | 4 + docs/index.md | 9 + mkdocs.yml | 149 +++++++ template.md | 13 + 14 files changed, 869 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 docs/01-home.md create mode 100644 docs/02-Blog/README.md create mode 100644 docs/02-Blog/first-post.md create mode 100644 docs/03-Narkdown-Examples/Advanced formatting syntax.md create mode 100644 docs/03-Narkdown-Examples/Basic formatting syntax.md create mode 100644 docs/03-Narkdown-Examples/Obsidian Flavored Markdown.md create mode 100644 docs/03-Narkdown-Examples/README.md create mode 100644 docs/For-Maq.md create mode 100644 docs/_assets/README.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml create mode 100644 template.md diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..fb25eed --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fdbdcef --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/docs/01-home.md b/docs/01-home.md new file mode 100644 index 0000000..6df5723 --- /dev/null +++ b/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/). + diff --git a/docs/02-Blog/README.md b/docs/02-Blog/README.md new file mode 100644 index 0000000..96ecc65 --- /dev/null +++ b/docs/02-Blog/README.md @@ -0,0 +1,4 @@ +--- +title: Blog +slug: blog +--- \ No newline at end of file diff --git a/docs/02-Blog/first-post.md b/docs/02-Blog/first-post.md new file mode 100644 index 0000000..d8cb2bd --- /dev/null +++ b/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..." + + + +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. diff --git a/docs/03-Narkdown-Examples/Advanced formatting syntax.md b/docs/03-Narkdown-Examples/Advanced formatting syntax.md new file mode 100644 index 0000000..b4c3148 --- /dev/null +++ b/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). diff --git a/docs/03-Narkdown-Examples/Basic formatting syntax.md b/docs/03-Narkdown-Examples/Basic formatting syntax.md new file mode 100644 index 0000000..f028e04 --- /dev/null +++ b/docs/03-Narkdown-Examples/Basic formatting syntax.md @@ -0,0 +1,373 @@ +--- +aliases: + - How to/Format your notes + - Markdown +--- + +Learn how to apply basic formatting to your notes, using [Markdown](https://daringfireball.net/projects/markdown/). For more advanced formatting syntax, refer to [[Advanced formatting syntax]]. + +## Paragraphs + +To create paragraphs, use a blank line to separate one or more lines of text. + +``` +This is a paragraph. + +This is another paragraph. +``` + +> [!note]- Multiple blank spaces +> Multiple adjacent blank spaces in and between paragraphs collapse to a single space when displaying a note in [[Edit and preview Markdown#Editor views|Reading view]] and on [[Introduction to Obsidian Publish|Obsidian Publish]] sites. +> +> ```md +> Multiple adjacent spaces +> +> +> +> and multiple newlines between paragraphs. +> ``` +> +> > Multiple adjacent spaces +> > +> > +> > +> > and multiple newlines between paragraphs. +> +> If you want to add multiple spaces, you can add ` ` (blank space) and `
` (newline) to your note. + +## Headings + +To create a heading, add up to six `#` symbols before your heading text. The number of `#` symbols determines the size of the heading. + +```md +# This is a heading 1 +## This is a heading 2 +### This is a heading 3 +#### This is a heading 4 +##### This is a heading 5 +###### This is a heading 6 +``` + +%% These headings use HTML to avoid cluttering the Outline/Table of contents %% +

This is a heading 1

+

This is a heading 2

+

This is a heading 3

+

This is a heading 4

+
This is a heading 5
+
This is a heading 6
+ +## Bold, italics, highlights + +Text formatting can also be applied using [[Editing shortcuts]]. + +| Style | Syntax | Example | Output | +|-|-|-|-| +| Bold | `** **` or `__ __` | `**Bold text**` | **Bold text** | +| Italic | `* *` or `_ _` | `*Italic text*` | *Italic text* | +| Strikethrough | `~~ ~~` | `~~Striked out text~~` | ~~Striked out text~~ | +| Highlight | `== ==` | `==Highlighted text==` | ==Highlighted text== | +| Bold and nested italic | `** **` and `_ _` | `**Bold text and _nested italic_ text**` | **Bold text and _nested italic_ text** | +| Bold and italic | `*** ***` or `___ ___` | `***Bold and italic text***` | ***Bold and italic text*** | + +Formatting can be forced to display in plain text by adding a backslash `\` in front of it. + +\*\*This line will not be bold\*\* + +```markdown +\*\*This line will not be bold\*\* +``` + +\**This line will be italic and show the asterisks*\* + +```markdown +\**This line will be italic and show the asterisks*\* +``` + +## Internal links + +Obsidian supports two formats for [[internal links]] between notes: + +- Wikilink: `[[Three laws of motion]]` +- Markdown: `[Three laws of motion](Three%20laws%20of%20motion.md)` + +## External links + +If you want to link to an external URL, you can create an inline link by surrounding the link text in brackets (`[ ]`), and then the URL in parentheses (`( )`). + +```md +[Obsidian Help](https://help.obsidian.md) +``` + +[Obsidian Help](https://help.obsidian.md) + +You can also create external links to files in other vaults, by linking to an [[Obsidian URI|Obsidian URI]]. + +```md +[Note](obsidian://open?vault=MainVault&file=Note.md) +``` + +### Escape blank spaces in links + +If your URL contains blank spaces, you must escape them by replacing them with `%20`. + +```md +[My Note](obsidian://open?vault=MainVault&file=My%20Note.md) +``` + +You can also escape the URL by wrapping it with angled brackets (`< >`). + +```md +[My Note]() +``` + +## External images + +You can add images with external URLs, by adding a `!` symbol before an [[#External links|external link]]. + +```md +![Engelbart](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg) +``` + +![Engelbart](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg) + +You can change the image dimensions, by adding `|640x480` to the link destination, where 640 is the width and 480 is the height. + +```md +![Engelbart|100x145](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg) +``` + +If you only specify the width, the image scales according to its original aspect ratio. For example: + +```md +![Engelbart|100](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg) +``` + +> [!tip] +> If you want to add an image from inside your vault, you can also [[Embed files#Embed an image in a note|embed an image in a note]]. + +## Quotes + +You can quote text by adding a `>` symbols before the text. + +```md +> Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society. + +\- Doug Engelbart, 1961 +``` + +> Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society. + +\- Doug Engelbart, 1961 + +> [!tip] +> You can turn your quote into a [[Callouts|callout]] by adding `[!info]` as the first line in a quote. + +## Lists + +You can create an unordered list by adding a `-`, `*`, or `+` before the text. + +```md +- First list item +- Second list item +- Third list item +``` + +- First list item +- Second list item +- Third list item + +To create an ordered list, start each line with a number followed by a `.` symbol. + +```md +1. First list item +2. Second list item +3. Third list item +``` + +1. First list item +2. Second list item +3. Third list item + +### Task lists + +To create a task list, start each list item with a hyphen and space followed by `[ ]`. + +```md +- [x] This is a completed task. +- [ ] This is an incomplete task. +``` + +- [x] This is a completed task. +- [ ] This is an incomplete task. + +You can toggle a task in Reading view by selecting the checkbox. + +> [!tip] +> You can use any character inside the brackets to mark it as complete. +> +> ```md +> - [x] Milk +> - [?] Eggs +> - [-] Eggs +> ``` +> +> - [x] Milk +> - [?] Eggs +> - [-] Eggs + +### Nesting lists + +All list types can be nested in Obsidian. + +To create a nested list, indent one or more list items: + +```md +1. First list item + 1. Ordered nested list item +2. Second list item + - Unordered nested list item +``` + +1. First list item + 1. Ordered nested list item +2. Second list item + - Unordered nested list item + +Similarly, you can create a nested task list by indenting one or more list items: + +```md +- [ ] Task item 1 + - [ ] Subtask 1 +- [ ] Task item 2 + - [ ] Subtask 1 +``` + +- [ ] Task item 1 + - [ ] Subtask 1 +- [ ] Task item 2 + - [ ] Subtask 1 + +Use `Tab` or `Shift+Tab` to indent or unindent one or more selected list items for easy organization. + +## Horizontal rule + +You can use three or more stars `***`, hyphens `---`, or underscore `___` on its own line to add a horizontal bar. You can also separate symbols using spaces. + +```md +*** +**** +* * * +--- +---- +- - - +___ +____ +_ _ _ +``` + +*** + +## Code + +You can format code both inline within a sentence, or in its own block. + +### Inline code + +You can format code within a sentence using single backticks. + +```md +Text inside `backticks` on a line will be formatted like code. +``` + +Text inside `backticks` on a line will be formatted like code. + +If you want to put backticks in an inline code block, surround it with double backticks like so: inline ``code with a backtick ` inside``. + +### Code blocks + +To format a block of code, surround the code with triple backticks. + +~~~ +``` +cd ~/Desktop +``` +~~~ + +```md +cd ~/Desktop +``` + +You can also create a code block by indenting the text using `Tab` or 4 blank spaces. + +```md + cd ~/Desktop +``` + +You can add syntax highlighting to a code block, by adding a language code after the first set of backticks. + +~~~md +```js +function fancyAlert(arg) { + if(arg) { + $.facebox({div:'#foo'}) + } +} +``` +~~~ + +```js +function fancyAlert(arg) { + if(arg) { + $.facebox({div:'#foo'}) + } +} +``` + +Obsidian uses Prism for syntax highlighting. For more information, refer to [Supported languages](https://prismjs.com/#supported-languages). + +> [!note] +> [[Edit and preview Markdown#Source mode|Source mode]] and [[Edit and preview Markdown#Live Preview|Live Preview]] do not support PrismJS, and may render syntax highlighting differently. + +## Footnotes + +You can add footnotes[^footnote] to your notes using the following syntax: + +[^footnote]: This is a footnote. + +```md +This is a simple footnote[^1]. + +[^1]: This is the referenced text. +[^2]: Add 2 spaces at the start of each new line. + This lets you write footnotes that span multiple lines. +[^note]: Named footnotes still appear as numbers, but can make it easier to identify and link references. +``` + +You can also inline footnotes in a sentence. Note that the caret goes outside the brackets. + +```md +You can also use inline footnotes. ^[This is an inline footnote.] +``` + +> [!note] +> Inline footnotes only work in reading view, not in Live Preview. + +## Comments + +You can add comments by wrapping text with `%%`. Comments are only visible in Editing view. + +```md +This is an %%inline%% comment. + +%% +This is a block comment. + +Block comments can span multiple lines. +%% +``` + +## Learn more + +To learn more advanced formatting syntax, such as tables, diagrams, and math expressions, refer to [[Advanced formatting syntax]]. + +To learn more about how Obsidian parses Markdown, refer to [[Obsidian Flavored Markdown]]. diff --git a/docs/03-Narkdown-Examples/Obsidian Flavored Markdown.md b/docs/03-Narkdown-Examples/Obsidian Flavored Markdown.md new file mode 100644 index 0000000..9f0d978 --- /dev/null +++ b/docs/03-Narkdown-Examples/Obsidian Flavored Markdown.md @@ -0,0 +1,20 @@ +Obsidian strives for maximum capability without breaking any existing formats. As a result, we use a combination of flavors of [[Basic formatting syntax|Markdown]]. + +Obsidian supports [CommonMark](https://commonmark.org/), [GitHub Flavored Markdown](https://github.github.com/gfm/), and [LaTeX](https://www.latex-project.org/). Obsidian does not support using Markdown formatting or blank lines inside of HTML tags. + +### Supported Markdown extensions + +| Syntax | Description | +| --------------- | --------------------------------------------------------------------- | +| `[[Link]]` | [[Internal links]] | +| `![[Link]]` | [[Embed files]] | +| `![[Link#^id]]` | [[Internal links#Link to a block in a note\|Block references]] | +| `^id` | [[Internal links#Link to a block in a note\|Defining a block]] | +| `%%Text%%` | [[Basic formatting syntax#Comments\|Comments]] | +| `~~Text~~` | [[Basic formatting syntax#Bold, italics, highlights\|Strikethroughs]] | +| `==Text==` | [[Basic formatting syntax#Bold, italics, highlights\|Highlights]] | +| `` ``` `` | [[Basic formatting syntax#Code blocks\|Code blocks]] | +| `- [ ]` | [[Basic formatting syntax#Task lists\|Incomplete task]] | +| `- [x]` | [[Basic formatting syntax#Task lists\|Completed task]] | +| `> [!note]` | [[Callouts]] | +| (see link) | [[Advanced formatting syntax#Tables\|Tables]] | diff --git a/docs/03-Narkdown-Examples/README.md b/docs/03-Narkdown-Examples/README.md new file mode 100644 index 0000000..79d8574 --- /dev/null +++ b/docs/03-Narkdown-Examples/README.md @@ -0,0 +1,3 @@ +--- +title: Markdown Examples +--- \ No newline at end of file diff --git a/docs/For-Maq.md b/docs/For-Maq.md new file mode 100644 index 0000000..ada76bf --- /dev/null +++ b/docs/For-Maq.md @@ -0,0 +1,21 @@ +--- +title: For Maq +description: Things to Bring to Maq's attention +--- + +## Suggested Corrections + +### In the repo's README file Under 'Features' / pub-obsidian + +- the link to `Obsidian.md' has a typo + +### Under 'Setting up meta / Navigation automatic generation' + +- link to "this documentation repository" goes to the old repository link + +### Blog URL is 'index-0' + +Under '02-Blog', I've created a README.md file with the name 'Blog', and slug of 'blog'. In the footer navigation on the 'Home' page, the blog page's url is 127.0.0.1:8000/index-0/ + +I can't figure out how to change the url to 'Blog'. + diff --git a/docs/_assets/README.md b/docs/_assets/README.md new file mode 100644 index 0000000..d5cfdbe --- /dev/null +++ b/docs/_assets/README.md @@ -0,0 +1,4 @@ +--- +title: '' +--- + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..ab63e1a --- /dev/null +++ b/docs/index.md @@ -0,0 +1,9 @@ +--- +title: Home +slug: index +redirect: 01-home.md +publish: hidden +--- + +# Index Text Here + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..bff5185 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,149 @@ +site_name: Test Site For Publisher for MkDocs +site_url: https://benotdeceived.org/Test-MkDocs-Publisher +site_author: Author's Name +site_description: Testing Publisher for MkDocs +copyright: > + © 2024 - Copyright Owner + +# site_dir: docs +# +# use_directory_urls: true +# strict: true + +# dev_addr: 127.0.0.1:8666 + +# extra: +# homepage: https://benotdeceived.org/Test-MkDocs-Publisher + +# extra_css: +# - assets/stylesheets/publisher.css + +extra_javascript: + # MathJax + - assets/javascripts/mathjax.js + - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js + # Icons hack + - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/js/all.min.js + +#watch: +# - overrides + +theme: + name: material + language: en + font: + code: Lato +# custom_dir: overrides +# logo: publisher_logo.png +# favicon: publisher_icon.png + + palette: + + # Palette toggle for light mode + - scheme: default + toggle: + icon: material/lightbulb + name: Switch to dark mode + primary: Indigo + accent: blue + # Palette toggle for dark mode + - scheme: slate + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + primary: deep purple + accent: purple + + features: + - navigation.tabs + # - navigation.tabs.sticky + - navigation.footer # Prev/Next page + - navigation.tracking # Anchor tracking + - navigation.top # Back to top + - navigation.sections # Useful for an overview + - navigation.indexes # Needed for an overview +# - navigation.instant +# - navigation.instant.progress + - search.suggest + - search.highlight + - search.share +# - content.action.edit +# - content.action.view +# - content.code.copy +# - content.code.annotate +# - content.tabs.link + - toc.follow + +markdown_extensions: + - admonition + - attr_list + - def_list + - footnotes + - md_in_html + - sane_lists + - tables + - toc: + permalink: true + permalink_title: Anchor link to this section for reference + - pymdownx.arithmatex: + generic: true + - pymdownx.betterem + - pymdownx.critic + - pymdownx.caret + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + auto_title: false + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + use_pygments: true + - pymdownx.inlinehilite + - pymdownx.keys + - pymdownx.magiclink + - pymdownx.mark + - pymdownx.tabbed: + alternate_style: true + slugify: !!python/object/apply:pymdownx.slugs.slugify + kwds: + case: lower + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + - pymdownx.saneheaders + - pymdownx.smartsymbols + - pymdownx.snippets + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + +plugins: + - pub-debugger: + console_log: +# show_code_link: true + enabled: true +# log_level: DEBUG +# filter_logger_names: +# - mkdocs.plugins +# - mkdocs.structure.files +# - mkdocs.structure.pages +# - mkdocs.plugins.publisher.meta.plugin +# - mkdocs.plugins.publisher.blog.creators +# - mkdocs.plugins.publisher.blog.modifiers +# - mkdocs.plugins.publisher.blog.parsers +# - mkdocs.plugins.publisher.debug.plugin +# - mkdocs.plugins.publisher.minifier.base +# - mkdocs.plugins.publisher.minifier.plugin +# - mkdocs.plugins.publisher.social.plugin +# - mkdocs.commands.build + - search + - pub-meta + - pub-blog: + blog_dir: 02-Blog + - pub-obsidian + - pub-social + - pub-minifier diff --git a/template.md b/template.md new file mode 100644 index 0000000..da3743e --- /dev/null +++ b/template.md @@ -0,0 +1,13 @@ +--- +title: Meta Template +slug: document-slug +description: Short document description +image: /some/url/to/image.png +date: 2023-05-19 15:40:36 +update: 2023-06-12 14:16:52 +publish: true +--- + +# Publisher for MkDocs Meta Template + +Just a template file containing template for metadata for files. \ No newline at end of file