Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/alphaolomi/my-notes
mkdocs mkdocs-material personal-notes
Last synced: about 2 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/alphaolomi/my-notes
- Owner: alphaolomi
- Created: 2022-09-14T17:33:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T03:28:56.000Z (5 months ago)
- Last Synced: 2024-08-26T04:45:52.217Z (5 months ago)
- Topics: mkdocs, mkdocs-material, personal-notes
- Homepage: https://notes.alphaolomi.dev
- Size: 57.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Alpha's Programming Notes [](https://app.netlify.com/sites/dancing-maamoul-d6bdf9/deploys)
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:
```bash
# 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](https://www.sublimetext.com/) because of its speed and lightweight nature.
- **Site Generation**: The site is built with [MkDocs](https://www.mkdocs.org/), a static site generator perfect for project documentation.
- **Theme and Extensions**: The theme used is [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), along with various plugins to enhance functionality.
- **Hosting**: The source markdown files are hosted on [GitHub](https://github.com/alphaolomi/my-notes).
- **Deployment**: The site is deployed via [Netlify](https://netlify.com) and can be accessed at [notes.alphaolomi.dev](https://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](https://code.visualstudio.com/) is also a great choice for editing markdown and code.
- **Markdown Preview**: Use a markdown previewer like [Markdown Preview Enhanced](https://shd101wyy.github.io/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](https://twitter.com/alphaolomi) or connect with me on [LinkedIn](https://www.linkedin.com/in/alphaolomi/).
Feel free to explore, learn, and contribute. Happy coding!