Create a personal website

Table of Contents

1. Intro
2. Prerequisites
3. Startup
4. Customize your website
5. Test locally
6. Enable GitHub Pages
7. Access your website

Intro

You can use this project to create a simple personal static website using MkDocs Material and deploying it for free with GitHub Actions. You will also host your website for free using GitHub Pages. MkDocs Material is a popular static site generator that allows you to create elegant and user-friendly documentation or personal websites.

Prerequisites

Before begin, make sure you have the following prerequisites in place:

• A GitHub account: you'll need a GitHub account to host your website using GitHub Pages.
• Git: you should have Git installed on your local machine.
• Markdown knowledge: familiarity with Markdown is a plus, as MkDocs uses Markdown for content.
• Poetry as dependencies manager

(back to top)

Startup

Use this command to initialize the project. This command also install pre-commit checks to guarantee code quality.

make init_project

(back to top)

Customize your website

You can now customize your website by editing the mkdocs.yml file to define the structure and theme of your site.

Test locally

Run this command to check out your site on localhost

make docs_launch

(back to top)

Enable GitHub Pages

1. Go to your GitHub repository and navigate to the "Settings" tab.
2. Scroll down to the "GitHub Pages" section.
3. In "Build and deployement" select Github Actions
4. Click "Save."

(back to top)

Access your website

After a few moments, your website will be available at https://your-username.github.io (replace your-username with your GitHub username). You have successfully created a personal website using MkDocs Material, deployed it for free with GitHub Actions, and hosted it for free using GitHub Pages. You can now continue to customize your website, add content, and share your knowledge with the world!

(back to top)