dotfiles

My PC Dotfiles & Website

README.md (2583B)


Rendered

My Personal Website

website

Built with Zola
Deployed via Nix and Cloudflare
Hosted at maydayv7.dev

Build

You can grab all the required dependencies using nix develop github:maydayv7/dotfiles#website or nix-shell

For testing, run the following commands:

zola -r site check
zola -r site serve

Then click here

To build the site, run nix build .#website. The build also subsets webfonts, retaining text glyphs, ligatures, and Nerd icons referenced by generated HTML/CSS/JS.

To produce the same optimized assets from the site development shell:

zola build
python3 scripts/optimize_fonts.py public

To override the URL, run:

nix build --impure --expr 'with (builtins.getFlake (toString ../.)).legacyPackages.x86_64-linux; callPackage ./site { site = "URL"; }'

Continuous Integration

GitHub Actions is used to automatically build the site and deploy it to Cloudflare

Features

  • Pagination
  • Categories
  • Social Links
  • Search
  • Analytics
  • Comments using Disqus/Giscus
  • Theme Switcher
  • Syntax Highlighting Theme
  • KaTeX Support -
  • Inline : \\( \KaTeX \\) / $ \KaTeX $
  • Block-Style : \\[ \KaTeX \\] / $$ \KaTeX $$
  • Shortcodes -
  • URL : {{ url(path="LINK", text="NAME") }}
  • Image : {{ image(src="PATH", alt="Alternative Text", position="left", style="border-radius: 8px;") }}
  • Figure : Extends Image - {{ figure(caption_position="left", caption="CAPTION", caption_style="font-weight: bold;") }}
  • GitHub : Star Count - {{ github(repo="USER/NAME") }}
  • YouTube : Embed Video - {{ youtube(id="ID") }}

git frontend

The git directory contains the configuration for my static git frontend, hosted at git.maydayv7.dev
It is built using my stagit fork to generate static HTML pages for my repositories
To build it, run nix run .#build-stagit
GitHub Actions is used to automatically build the site and deploy it to Cloudflare every week


Code

## My Personal Website

[![website](../files/images/website.png)](https://maydayv7.dev)

Built with [Zola](https://www.getzola.org/)  
Deployed via [Nix](https://nixos.org/) and [Cloudflare](https://www.cloudflare.com/)  
Hosted at [maydayv7.dev](https://maydayv7.dev)

### Build

You can grab all the required dependencies using `nix develop github:maydayv7/dotfiles#website` or `nix-shell`

For testing, run the following commands:

```
zola -r site check
zola -r site serve
```

Then click [here](http://localhost:1111)

To build the site, run `nix build .#website`.
The build also subsets webfonts, retaining text glyphs, ligatures, and Nerd icons referenced by generated HTML/CSS/JS.

To produce the same optimized assets from the `site` development shell:

```sh
zola build
python3 scripts/optimize_fonts.py public
```

To override the URL, run: <pre><code>nix build --impure --expr 'with (builtins.getFlake (toString ../.)).legacyPackages.x86_64-linux; callPackage ./site { site = "<b><i>URL</i></b>"; }'</code></pre>

#### Continuous Integration

[`GitHub Actions`](../.github/workflows/website.yml) is used to automatically build the site and deploy it to Cloudflare

### Features

- [x] Pagination
- [x] Categories
- [x] Social Links
- [x] Search
- [x] Analytics
- [x] Comments using [Disqus](https://disqus.com/)/[Giscus](https://giscus.app/)
- [x] Theme Switcher
- [x] Syntax Highlighting Theme
- [x] [KaTeX](https://katex.org/) Support -
  - Inline : `\\( \KaTeX \\)` / `$ \KaTeX $`
  - Block-Style : `\\[ \KaTeX \\]` / `$$ \KaTeX $$`
- Shortcodes -
  - [x] URL : <code>{{ url(path="<b>LINK</b>", text="<b>NAME</b>") }}</code>
  - [x] Image : <code>{{ image(src="<b>PATH</b>", alt="<i>Alternative Text</i>", position="<i>left</i>", style="<i>border-radius: 8px;</i>") }}</code>
  - [x] Figure : Extends Image - <code>{{ figure(caption_position="<i>left</i>", caption="<b>CAPTION</b>", caption_style="<i>font-weight: bold;</i>") }}</code>
  - [x] GitHub : Star Count - <code>{{ github(repo="<b>USER</b>/<b>NAME</b>") }}</code>
  - [x] YouTube : Embed Video - <code>{{ youtube(id="<b>ID</b>") }}</code>

## `git` frontend

The [`git`](./git) directory contains the configuration for my static `git` frontend, hosted at [git.maydayv7.dev](https://git.maydayv7.dev)  
It is built using my `stagit` [fork](https://github.com/maydayv7/stagit) to generate static HTML pages for my repositories  
To build it, run `nix run .#build-stagit`  
[`GitHub Actions`](../.github/workflows/website-git.yaml) is used to automatically build the site and deploy it to Cloudflare every week