Markdown notes

In VS Code type (../ to bring up pop-up and navigate to file for internal link...

Top MkDocs extensions
https://chrieke.medium.com/the-best-mkdocs-plugins-and-customizations-fc820eb19759

PyMdown Extensions
https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/

Add some recommended extensions using the full path:

site_name: Tech & Programming Notes
repo_url: https://github.com/EDIflyer/linux-notes
repo_name: EDIflyer/linux-notes
edit_uri: edit/main/docs/

theme:
  name: material
  logo: images/logo.svg
  favicon: images/favicon.ico
  features:
    - content.code.annotate
    - navigation.top
    - content.code.copy
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: deep orange
      toggle:
        icon: material/brightness-7 
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    admonition:
      example: fontawesome/solid/file-code
      quote: fontawesome/solid/terminal
      tip: fontawesome/solid/lightbulb

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - git-revision-date-localized:
      type: custom
      custom_format: "%d/%m/%Y %T"
      timezone: Europe/London
      locale: en
      fallback_to_build_date: false
      enable_creation_date: true
      exclude:
          - index.md
      enabled: true
  - glightbox
  - awesome-pages

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - 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:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo: "linux-notes"
      user: "EDIflyer"
      repo_url_shorthand: true
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

Add some triggerscript:

List of markdown options
https://squidfunk.github.io/mkdocs-material/reference/

List of markdown extensions (NB not all supported by Material for MkDocs) https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/

To highlight codeblocks, enclose them in triple backwards quotes and also use https://pygments.org/docs/lexers/ to give the language at the start and add linenums="1" if you want to add line numbers:

``` bash linenums="1"
cd newdir
```

Internal link, just use # and the relevant title/sub-title, replacing spaces with hyphens

First Header	Second Header
Content Cell	Content Cell
Content Cell	Content Cell

Test change

This page was last updated: 27/10/2022 22:37:55
This site was last updated: 19/11/2024 16:28:00

Handy markdown cheatsheet: https://yakworks.github.io/docmark/cheat-sheet/ Tutorial: https://commonmark.org/help/tutorial/

Remember for lists to add a blank line before and after starting the list. For numbered lists a period is required after the number (incremental numbers don't need to be used, just use 1 and it will automatically calculate the others)