{"id":15169149,"url":"https://github.com/aazih/aamiranauthor_web","last_synced_at":"2026-02-15T19:09:28.349Z","repository":{"id":227733223,"uuid":"772141340","full_name":"Aazih/aamiranauthor_web","owner":"Aazih","description":"Personal website and blog","archived":false,"fork":false,"pushed_at":"2025-06-26T13:59:44.000Z","size":16823,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-26T14:50:16.870Z","etag":null,"topics":["blog","mkdocs","mkdocs-material","website"],"latest_commit_sha":null,"homepage":"https://www.aamiranauthor.ca","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Aazih.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-03-14T16:01:55.000Z","updated_at":"2025-06-26T13:59:45.000Z","dependencies_parsed_at":"2024-09-22T22:00:34.923Z","dependency_job_id":"04fb4092-b73d-4ddf-888d-eb84ba3fa1e7","html_url":"https://github.com/Aazih/aamiranauthor_web","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"e61d8c73a7eec7ad5cf10d896775e46e2141944c"},"previous_names":["aazih/aamiranauthor_web"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Aazih/aamiranauthor_web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aazih%2Faamiranauthor_web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aazih%2Faamiranauthor_web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aazih%2Faamiranauthor_web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aazih%2Faamiranauthor_web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Aazih","download_url":"https://codeload.github.com/Aazih/aamiranauthor_web/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aazih%2Faamiranauthor_web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273854345,"owners_count":25180007,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog","mkdocs","mkdocs-material","website"],"created_at":"2024-09-27T07:01:00.877Z","updated_at":"2026-02-15T19:09:28.337Z","avatar_url":"https://github.com/Aazih.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aamiranauthor_web\n\n[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge\u0026logo=MaterialForMkDocs\u0026logoColor=white)](https://squidfunk.github.io/mkdocs-material/)\n\n## Purpose\n\nThe purpose of this project is to create a Material for Mkdocs website, not as a documentation portal, but for my personal website as an author.\n\nThe purpose of this readme is to document the steps I went through to install and use Material for Mkdocs as I find it incredibly valuable for my very limited memory to refer back to what I actually did step by step and decision by decision.\n\nWhile this is a personal reference, perhaps the step by step approach might be of use as a reference for someone else as well.\n\n## Initial Steps\n\n1. Create github repository (in previously existing github account)\n2. Install Git for Windows\n3. Clone repository via Visual Studio Code and https\n4. Start updating readme\n5. Create python virtual environment using `py -m venv venv`\n6. Activate python virtual environment `.\\venv\\Scripts\\activate` (Windows)\n7. Within python virtual environment: Install material-mkdocs `pip install mkdocs-material`\n8. Within python virtual environment: Create new mkdocs site `mkdocs new .`\n9. Update mkdocs.yml: add material theme `theme:  name: material` (two separate lines)\n\n## Social Card Steps\n\n1. Install [Msys2](https://www.msys2.org/)\n2. Within Msys2 run `pacman -S mingw-w64-x86_64-gtk4`\n3. Add to Windows PATH `C:\\msys64\\mingw64\\bin\\`\n4. Within python virtual environment `pip install \"mkdocs-material[imaging]\"`\n\n## Ongoing\n\n- From within python virtual environment Run mkdocs webserver locally to view site as is `mkdocs serve`\n- From within python virtual environment build site to move to private webspace `mkdocs build`\n\n### Source Control (VsCode Git extension connected to github repo)\n\n1. Create a new branch by hitting branch button in bottom left bar\n2. Choose Create a new branch option from top bar, name branch, hit confirm\n3. On Source Control Tab: Stage file via + option either next to a file or the top level Changes folder\n4. On Source Control Tab: Type Commit Message and hit Commit button\n5. On Source Control Tab: Hit Sync Changes (Publish Branch?) button to 'push' to Github\n\n### Source Control (Github)\n\n1. Create pull request between new branch and main\n2. Merge pull request\n3. Confirm merge\n4. Delete branch\n\n## Upload\n\n1. Zip contents of Material for Mkdocs generated site directory\n2. Login to cPanel and go to file manager\n3. Upload zipped file into aamiranauthor root and extract\n\n## Tools Used\n\n| Tool | Comment |\n| --- | --- |\n| GitHub | Source Control |\n| Visual Studio Code | Code Editor \u0026 related tools |\n| Python | Language for static site generator |\n| Mkdocs | Static site generator using Markdown |\n| Material for Mkdocs | Extensive theme for Mkdocs |\n| markdownlint VS Code extension | Linter for Markdown |\n| Spell Right VS Code extension | Spellchecker |\n| ASUS laptop | Hardware |\n| Windows 11 | OS |\n\n## Credits\n\nStarry effect from: [Ibrahim AbdulHameed](https://codepen.io/Ibrahim-Abdulhameed/pen/oNJMEGV) and [sarazond](https://codepen.io/sarazond/pen/LYGbwj)\n\n## TODO\n\nFuture plan: Local linktree\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faazih%2Faamiranauthor_web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faazih%2Faamiranauthor_web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faazih%2Faamiranauthor_web/lists"}