leo3418.github.io

This is the repository for my personal site.

Technical Overview

This site is based on Hugo. The theme it uses is a custom port of the Minimal Mistakes Jekyll theme to Hugo. Changes to the site are deployed to GitHub Pages automatically by a GitHub Actions workflow.

Directory Structure of Source Files

The source files for this site are organized in compliance with Hugo's default directory structure for sites. The custom Hugo templates this site uses (all of which are under the layouts/ directory) also respect some special paths:

• assets/js/plugins/: JavaScript plugins and libraries used by this site's scripts
• static/css/syntax.css: The syntax highlighter stylesheet
• static/img/, static/res/: Images and miscellaneous resource files for this site
  • For details about how these directories' contents are organized, please read the comment at the top of file layouts/shortcodes/static-path.html in this repository.

Generating the Site

First, ensure the extended version of Hugo v0.115.0 or later is installed. The installation instructions are available here.

• The extended version is required because this site has SCSS files, which only the extended version can handle.
• This site depends on features introduced since Hugo v0.115.0, hence the Hugo version requirement.

To start a local development server for previewing, change the working directory to this repository's root, and run command hugo server. By default, the site is accessible via http://localhost:1313/.

To write the site's files to disk, run command hugo. By default, the files are written to the public/ directory under this repository's root.

Reusing Contents in This Repository

Feel free to reuse any files under the these directories in this repository to build your own Hugo site:

• archetypes/
• assets/
• config/
• i18n/
• layouts/
• static/css/
• static/js/

Note that some of these files come from other projects and are covered by certain license terms. More details are given in the License Information section below.

The majority of the content on this site's pages, such as text and images, is provided under a certain license. The content is usually placed under the content/ and static/img/ directories. The licensing information for a piece of content is indicated on the generated webpage. If you want to reuse any content of such kind, please comply with the terms of the license.

Licensing Information

This site uses SCSS files, JavaScript snippets, Hugo templates translated from Liquid snippets, HTML DOM definitions, and UI strings from Minimal Mistakes, which is copyright (C) 2013-2020 Michael Rose and contributors. Its license can be found here.

This site uses asciinema player, which is copyright (C) 2011-2022 Marcin Kulik. Its license can be found here.

This site uses Breakpoint, which is copyright (C) 2012-2022 Sam Richard and others and is stored at assets/sass/minimal-mistakes/vendor/breakpoint/ in this repository. Its license can be found here.

This site uses Font Awesome Free, which is copyright (C) 2022 Fonticons, Inc. Its license can be found here.

This site uses Gumshoe, which is copyright (C) Go Make Things, LLC and is stored at assets/js/plugins/gumshoe.js in this repository. Its license can be found here.

This site uses Susy, which is copyright (C) 2017, Miriam Eric Suzanne and is stored at assets/sass/minimal-mistakes/vendor/susy/ in this repository. Its license can be found here.