https://github.com/microcosem/emlikethedash

✨ My professional home on the net!
https://github.com/microcosem/emlikethedash

cloudflare-pages docker docker-compose mkdocs professional

Last synced: 10 days ago
JSON representation

✨ My professional home on the net!

• Host: GitHub
• URL: https://github.com/microcosem/emlikethedash
• Owner: microcosem
• Created: 2024-02-11T19:48:01.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-01-14T02:27:30.000Z (17 days ago)
• Last Synced: 2025-01-14T02:33:45.734Z (17 days ago)
• Topics: cloudflare-pages, docker, docker-compose, mkdocs, professional
• Language: Dockerfile
• Homepage: https://emlikethedash.pages.dev
• Size: 171 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: docs/README.md

Awesome Lists containing this project

README

        
![Built with Markdown](https://img.shields.io/badge/Markdown-blue) ![Built with Mkdocs](https://img.shields.io/badge/MkDocs-red) ![Built with Docker](https://img.shields.io/badge/Docker-blue)

## ✨ Welcome to my digital corner!

Hello and welcome! This repository holds the source for [my personal-professional website](https://emlikethedash.pages.dev).

## About the site

The site is built using [MkDocs](https://www.mkdocs.org) with [Material](https://squidfunk.github.io/mkdocs-material/), and is built and hosted for the public by [Cloudflare Pages](https://pages.cloudflare.com/).

## Building locally

To build the site locally for yourself, you may either [spin up a Docker container](#using-docker-and-docker-compose) or [run a local development server](#local-development) directly.

### Using Docker and docker-compose

#### Prerequisites

- [Docker](https://www.docker.com/)

- [Docker Compose](https://docs.docker.com/compose/)

#### Steps

1. Clone this repository.

1. Run `docker-compose up`.

1. Hit the local server at `localhost:8000`.

### Local development

#### Prerequisites

- [MkDocs](https://www.mkdocs.org/getting-started/#installation)

- Python3

#### Steps

1. Clone this repository.

1. From the repository's root, run `mkdocs build`.

    ```zsh

    $ mkdocs build

      

    INFO    -  Cleaning site directory

    INFO    -  Building documentation to directory: emheinz.github.io/site

    ```

1. Next, run `mkdocs serve`:

    ```zsh

    $ 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/

    ```

1. Hit the local server at `localhost:8000`.

## Thanks!

- Thanks [@conceptualshark](https://github.com/conceptualshark) for writing a [great Dockerfile and docker-compose file for MkDocs sites](https://github.com/conceptualshark/conceptualshark.github.io/tree/main).