Dotfiles

screenshot of Dotfiles
mkdocs
vitepress

My dotfiles

Overview

The dotfiles repository offers an intriguing glimpse into a developer's personal configuration management setup for both macOS and Linux systems. With the ambition of maintaining a seamless experience across devices, this repository integrates tools like Chezmoi for managing dotfiles, along with unique solutions for handling various programming languages. While the setup is tailored for personal use, it provides a fascinating look into the configuration practices of a seasoned developer. However, users should approach with caution, as the creator acknowledges that there are some sharp edges and no guarantees of easy use.

This repository reflects a practical yet experimental approach to dotfile management. The creative solutions, such as using "literate configuration" and a custom tool for tangling markdown, demonstrate a commitment to innovation, even if it comes with its own set of challenges. With a mix of personal touches and technical details, this project is a real treasure trove for those looking to navigate the complexities of customizing their environments.

Features

  • Chezmoi Management: Centralizes dotfile management while facilitating pre and post-installation scripts to ensure all dependencies are installed.
  • Language Management: Utilizes a custom abstraction for installing various programming languages, distinguishing between home and work configurations.
  • Literate Configuration: Employs markdown files alongside traditional config files to create a narrative-driven configuration process.
  • Tangling Utility: Features a unique tool called lugh for converting markdown sources into executable configuration files, streamlining the setup process.
  • Custom Shell Setup: Primarily uses Zsh with Oh-My-Zsh, yet remains flexible by allowing occasional switches for simplicity.
  • Installation Complexity: Designed for personal use but includes notes on potential bootstrapping issues during setup on new machines.
  • Extras Provision: Lists additional manual installations for enhanced aesthetics, such as a themed wallpaper and a specific font.
mkdocs
MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

vitepress
Vitepress

VitePress is a static site generator designed for creating documentation websites. It offers a lightweight and fast development experience using Vue.js and Markdown, with features such as live-reload, theming, and customizable layout components.