https://github.com/mso-docs/mackenzie-techdocs-site
This is the Mackenzie.TechDocs project, where I am learning how to create a documentation site from scratch.
https://github.com/mso-docs/mackenzie-techdocs-site
documentation mkdocs technical-writing writing-tool
Last synced: about 1 month ago
JSON representation
This is the Mackenzie.TechDocs project, where I am learning how to create a documentation site from scratch.
- Host: GitHub
- URL: https://github.com/mso-docs/mackenzie-techdocs-site
- Owner: mso-docs
- Created: 2025-08-03T05:32:08.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-08-03T05:52:01.000Z (11 months ago)
- Last Synced: 2025-08-03T07:17:44.316Z (11 months ago)
- Topics: documentation, mkdocs, technical-writing, writing-tool
- Language: JavaScript
- Homepage:
- Size: 6.82 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](release-notes.md) 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](blog.md) page; Created in-page links |
| | | Resolved | Resolved emoji loading issue with blog post (affected direct linking to specific posts); Updated [Release Notes](release-notes.md) page; Updated [README](README.md) page; Responded to GitHub issue requesting the above changes |
| 1.2.1 | 08/03/2025 | Added | Added project to GitHub; Added [Blog](blog.md) page; Fixed blog post formatting; Added [Examples](examples.md) 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](release-notes.md) page |
| | | Resolved | Removed stock favicon; Fixed Tech Stack section on [About](about.md) page; Fixed header typos; Updated [About](about.md) page; Removed redundant headers; Removed ".io" from site name |
| 1.1.0 | 08/01/2025 | Added | Added [About](about.md) and [Contact](contact.md) 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!