Skip to content

This is the Mackenzie.TechDocs project, where I am learning how to create a documentation site from scratch.

Notifications You must be signed in to change notification settings

mso-docs/mackenzie-techdocs-site

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mackenzie.TechDocs

Welcome to the Mackenzie.TechDocs Project!

This is my technical writing website, which was made with MkDocs. I will be updating this page soon. Stay tuned!

Some facts about this site:

  • It utilizes Markdown, CSS, HTML, JavaScript, and YAML!
  • It is where you can find some of my work.
  • It has a blog, which I hope to update (semi) frequently.
  • It is where you can find links to other places I hang out online.
  • It is a huge labor of love!

Sitemap

Below, you can see the way the site is organized.

mkdocs.yml              # Project configuration
docs/
│
├── index.md            # Homepage for Mackenzie.TechDocs
├── about.md            # About me and this project
├── contact.md          # My contact information
│
├── blog.md             # Blog about technical writing
├── examples.md         # Samples of my work
├── release-notes.md    # Changelog or version history

Changelog

You can view the changelog in full on the Release Notes section of the site.

Here is a brief synopsis of what I've done on the site:

Version Date Type Notes
1.2.2 08/04/2025 Added Added new blog posts to Blog page; Created in-page links
Resolved Resolved emoji loading issue with blog post (affected direct linking to specific posts); Updated Release Notes page; Updated README page; Responded to GitHub issue requesting the above changes
1.2.1 08/03/2025 Added Added project to GitHub; Added Blog page; Fixed blog post formatting; Added Examples page
Resolved Fixed persistent formatting issue; Formatted documentation example to match site formatting
1.2.0 08/02/2025 Added Added CSS/HTML styles; Updated favicon; Added branding; Updated site name; Added Release Notes page
Resolved Removed stock favicon; Fixed Tech Stack section on About page; Fixed header typos; Updated About page; Removed redundant headers; Removed ".io" from site name
1.1.0 08/01/2025 Added Added About and Contact pages; Added portfolio and GitHub links; Site-wide copywriting; Edited directory; Added nav bar items
Resolved Fixed Index page content; Revised intro for web; Removed dummy text
1.0.0 06/04/2025 Added Initial site build; Tested functionality; Researched MkDocs; Edited Index page
Resolved Fixed MkDocs serving issue by installing packages

Thanks For Reading!

You rock!

About

This is the Mackenzie.TechDocs project, where I am learning how to create a documentation site from scratch.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published