https://github.com/jconwell/iamjohn.me

Personal profile site, blog posts, and random things to share
https://github.com/jconwell/iamjohn.me

blog material-for-mkdocs mkdocs

Last synced: 3 months ago
JSON representation

Personal profile site, blog posts, and random things to share

• Host: GitHub
• URL: https://github.com/jconwell/iamjohn.me
• Owner: jconwell
• License: mit
• Created: 2023-01-19T22:42:27.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-28T17:02:39.000Z (over 1 year ago)
• Last Synced: 2024-07-29T19:15:05.180Z (6 months ago)
• Topics: blog, material-for-mkdocs, mkdocs
• Language: HTML
• Homepage: https://www.iamjohn.me
• Size: 4.51 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# My CV Web Page Written in Markdown

The markdown framework used to generate the site is called [MkDocs](https://www.mkdocs.org/user-guide/)

The mkdocs theme used is [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/)

## MkDocs Commands (for my reference)

* `mkdocs serve` - Start the live-reloading docs server.

* `mkdocs build` - Build the documentation site.

## Deploy to GitHub Pages

1. run `mkdocs build` to generate the `site/` folder

1. commit changes to the `site/` folder

1. GitHub action will deploy the `site/` folder to pages