TLDR / Personal Site

This repository contains the source code and content for my personal site, built using Mkdocs.

Table of Contents

• Installation
• Usage
• Contributing
• License
• Acknowledgements

Installation

To run the site locally, you'll need to have a local installation of Python (validated on 3.11) and follow the steps below:

1. Clone this repository: git clone https://github.com/BradyPlanden/bradyplanden.github.io.git
2. Change into the project directory: cd bradyplanden.github.io
3. Install the required dependencies: pip install -e .
4. Start the local development server: mkdocs serve
5. Open your browser and visit http://localhost:8000 to view the site.

Usage

The site is organized into different sections, such as TLDR posts, publications, and about me. Each section has its own folder and Markdown files. To make changes to the site, follow these steps:

1. Edit the Markdown files in the corresponding section folder.
2. Preview the changes locally using mkdocs serve.
3. Once you're satisfied with the changes, commit and push them to the repository / fork.

Contributing

If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.

Acknowledgements

This site is built with Material for MkDocs, and was inspired from "Why, Scott, Why?!". The 'mkdocs-custom' package was developed by Scott Pierce with the source provided here.