/duclos-cavalcanti.github.io

personal website automated through a bash script and pandoc

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

duclos-cavalcanti.github.io

Introduction

Source code to my personal website, currently served via Github Pages at https://www.duclos.dev. The webpage is generated via hugo using the PaperMod theme.

Background

The purpose of this repository is not only to easily deploy a static website, but also serve as a minor working example of how one can start a blog easily. The pro's to that approach are nothing other than just having a better understanding of how the website is created and how one can modify it further. Generally, to deploy a static website of any kind, the steps can be generalized as such:

  • Structure website: (manually or ssg)
  • Obtain a domain.
  • Install/Deploy a Web Server: (Nginx, Apache, etc)
  • Upload to Server/Cloud platform service (Optionally Netlify).
  • Optionally set up SSL certificates for HTTPS.

Through hugo it becomes easier to generate a static website based on markdown files. In addition to that, Github Pages facilitates the rest leaving us to only specify a URL and place the content correctly on the specified branch.

Dependencies

Debian/Ubuntu

  1. Installation
sudo apt install hugo texlive-latex-base texlive-xetex
# texlive-latex-base texlive-xetex: for resume/cover letters
# docker: enables easy and portable workflows
  1. Setup
hugo new site website --format yaml
cd website/themes && git clone git clone https://github.com/mrmierzejewski/hugo-theme-console
  1. Add Post
  • Create a new .md file in the content/posts folder
---
title: Title of the post
description:
date:
tldr: (optional)
draft: true/false (optional)
tags: [tag names] (optional)
---

Usage

Usage

Build

make

Deploy

make deploy

Serve Locally

make serve

Stop local serving

make stop

License

These files are released under the GPL 3.0 license. See LICENSE.

Thanks

References