Repository files navigation

A personal blogging website created to share my thoughts and experiences on software technologies and open source tools.

1. Static website builder:Hugo
2. Theme:PaperMod
3. Comments:Disqus
4. Diagrams:Mermaid
5. Dev Containers:Dev Containers

There are two ways to spin up this application

1. The hard way: Install everything in local and hope everything works in CI/CD as well :)
2. The easy way: Using dev containers. Just spin up the application in a docker container.

Make sure you have the following tools installed as pre-requisite. The steps are for mac, but you can use alternatives for your OS.

1. Install Hugo:brew install hugo
2. install pre-commit tool:pip install pre-commit

1. Clone the repository
2. Install pre-commit in your system by running:pip install pre-commit
3. Runpre-commit install -f to install thepre-commit hooks in the repository
4. Install hugo using the command:brew install hugo
5. Install the theme submodule using the command:git submodule update --init --recursive --remote
6. Installpre-commit extension in your text editor to maintain consistency in formatting. To install, run:brew install pre-commit and thenpre-commit-install to update the pre-commit hook in your local repository

You can use the devcontainers to run a pre-configured developement environment in your machine. This repository already has a prec-configured template indevcontainer/devcontainer.json. All you have to do is to run this application ongithub codespaces,vs code dev containers or any devcontainer of your choice.

To create a new content page run the command

hugo new content content/blog/<your-page-name>.md

To publish the content you will have to

1. Set thedraft key to false in the content page
2. Push the changes usinggit push command

1. Runpre-commit autoupdate to fetch and install the latest version of thepre-commit hooks
2. To generate a blog page, runhugo new content blog/<page-name>.md
3. To run the server with draft views enabled, runhugo server -D
4. To run the serverhugo server