alphaolomi / my-notes

These are a collection of code snippets I've used in the past and saved. Collection of short snippets, notes and TILs about things related to Programming Languages, Linux, DevOps tools, etc.

Alpha's Programming Notes

Welcome to Alpha's Programming Notes! This repository is a curated collection of my programming insights, code snippets, and Today-I-Learned (TIL) entries. It serves as a quick reference guide covering various programming languages, Linux commands, DevOps tools, and more.

Local Setup

To preview and work on the site locally, follow these steps:

# Create a virtual environment
python3 -m venv venv

# Activate the virtual environment
source venv/bin/activate

# Install the required packages
pip install -r requirements.txt

# Serve the site locally
mkdocs serve

Project Context & Workflow

This project is the result of years of accumulated knowledge and learning. I initially started writing these notes for personal use, but I have decided to share them publicly to benefit the wider developer community.

Tools and Technologies

• Writing: I use Sublime Text because of its speed and lightweight nature.
• Site Generation: The site is built with MkDocs, a static site generator perfect for project documentation.
• Theme and Extensions: The theme used is Material for MkDocs, along with various plugins to enhance functionality.
• Hosting: The source markdown files are hosted on GitHub.
• Deployment: The site is deployed via Netlify and can be accessed at notes.alphaolomi.dev.

Contribution

Contributions are welcome! If you have suggestions for improvements or new notes, feel free to fork the repository and submit a pull request. Please ensure your contributions adhere to the existing style and structure.

Recommended Tools

• IDE: While I prefer Sublime Text, Visual Studio Code is also a great choice for editing markdown and code.
• Markdown Preview: Use a markdown previewer like Markdown Preview Enhanced for a real-time preview of your changes.
• Obsidian: Evaluating...

Connect with Me

Stay updated with the latest notes and updates. Follow me on Twitter or connect with me on LinkedIn.

Feel free to explore, learn, and contribute. Happy coding!