✨ Welcome to my digital corner!

Hello and welcome! This repository holds the source for my personal-professional website.

About the site

The site is built using MkDocs with Material, and is built and hosted for the public by Cloudflare Pages.

Building locally

To build the site locally for yourself, you may either spin up a Docker container or run a local development server directly.

Using Docker and docker-compose

Prerequisites

• Docker
• Docker Compose

Steps

1. Clone this repository.
2. Run docker-compose up.
3. Hit the local server at localhost:8000.

Local development

Prerequisites

• MkDocs
• Python3

Steps

1. Clone this repository.
2. From the repository's root, run mkdocs build.

   $ mkdocs build
     
   INFO    -  Cleaning site directory
   INFO    -  Building documentation to directory: emheinz.github.io/site

3. Next, run mkdocs serve:

   $ mkdocs serve
   
   INFO    -  Building documentation...
   INFO    -  Cleaning site directory
   INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
                - portfolio.md
   INFO    -  Documentation built in 0.34 seconds
   INFO    -  [13:29:30] Watching paths for changes: 'docs', 'mkdocs.yml'
   INFO    -  [13:29:30] Serving on http://127.0.0.1:8000/

4. Hit the local server at localhost:8000.

Thanks!

• Thanks @conceptualshark for writing a great Dockerfile and docker-compose file for MkDocs sites.