Skip to content

29/08/25 - Restructuring MkDocs

Restructuring

Seperating template.md into two seperate files. "How it works" is getting too big to have a markdown guide just slipped in at the bottom. I'll make a separate markdown file.

I also changed the structure of the files to:

.
├── docs
│   ├── 00-journal
│   │   ├── 2025-08-23.md
│   │   ├── 2025-08-24.md
│   │   ├── 2025-08-25
│   │   │   └── workflow-success.png
│   │   ├── 2025-08-25.md
│   │   ├── 2025-08-26.md
│   │   ├── 2025-08-27.md
│   │   ├── 2025-08-28.md
│   │   └── 2025-08-29.md
│   ├── index.md
│   ├── markdownguide.md
│   ├── MkDocs
│   │   ├── installationguide.md
│   │   └── test.md
│   └── tic-tac-toe
│       ├── app.js
│       ├── index.html
│       └── styles.css
├── mkdocs.yml
├── README.md
└── requirements.txt

I focused mostly on the nav bar. I left it yesterday in a sort of broken state, as long as it worked. I've got the drop down back and I've figured out having multiple drop downs.

So I've added a new section for MkDocs and put the installation guide from the README, yesterday's work, in there and I've moved the Markdown guide to it's own file.

I think the Markdown guide is going to become a useful resource for me, I'm happy I started this project.

Theming

Decided to just copy paste the palette section from the MkDocs Material repository.

It didn't have any issues, and looks better. Cool.

Went to the docs and looked into how to change the colours. Link

Actually, let's clean this yml up.

site_name: Documentation Station
site_url: https://odonnellrory.github.io/
repo_url: https://github.com/odonnellrory/odonnellrory.github.io
repo_name: odonnellrory/odonnellrory.github.io
edit_uri: blob/main/docs/         

# Configuration
theme:
  name: material
  custom_dir: docs/
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    primary: black
    scheme: slate

# Plugins
plugins:
  - search
  - awesome-pages                
  - minify                        
  - glightbox                      
  - git-revision-date-localized:
      type: date
      enable_creation_date: true

markdown_extensions:
  - admonition
  - def_list
  - footnotes
  - attr_list
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.tasklist

use_directory_urls: true          

# Fail builds on errors
strict: true                      

# Social
extra:
  social:
    - icon: fontawesome/brands/git-alt
      link: https://github.com/odonnellrory

To Do:

  • Make Markdown section a directory, it will likely get bigger like the other section was.
  • I want to set up an automated system for my machine to create the new journal file every day something like, 
if yymmdd.md does not exist, matching todays date, create it

and then get systemd to run it on boot.