Skip to content

Commit

Permalink
Merge pull request #1 from SilentGlasses/blog_n_more
Browse files Browse the repository at this point in the history
Add Blog feature and other updates
  • Loading branch information
SilentGlasses authored Feb 27, 2024
2 parents 393ee33 + 16b9f95 commit 9edf148
Show file tree
Hide file tree
Showing 10 changed files with 184 additions and 16 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: ci
on:
push:
branches:
- master
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
72 changes: 72 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
node_modules/
parts/
sdist/
var/
package*.json
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
*.mo

# Scrapy stuff:
.scrapy

# PyBuilder
target/

# IPython Notebook
.ipynb_checkpoints

# pyenv
.python-version

# virtualenv
venv/
ENV/

# MkDocs documentation
site*/
/site
.cache
Empty file removed docs/about.md
Empty file.
2 changes: 1 addition & 1 deletion docs/baseline/ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:

!!! danger "Important"
- Your SSH keys belong to you, not your computer. This means if you get a new computer, copy your existing keypair(s) over to the new one.
- **NEVER** share your private key. **Always** make sure you are ever only using the key found in your `<keyname.pub` file.
- **NEVER** share your private key. **Always** make sure you are ever only using the key found in your `<keyname>.pub` file.

## Choosing an Algorithm and Key Size

Expand Down
5 changes: 5 additions & 0 deletions docs/blog/.authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
authors:
silentglasses:
name: SIlentGlasses
description: Creator
avatar: https://github.com/silentglasses.png
39 changes: 39 additions & 0 deletions docs/blog/posts/embrace_the_penguin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
authors:
- silentglasses
date: 2024-02-26
---

# Embrace the Penguin 🐧💻

Greeting fellow open-source adventurers and Linux enthusiasts! Welcome to the world where the Penguin reigns supreme. Here you will find topics ranging from traversing the land of open-source, command-line mastery, customization and general topics that unfold within the world of Linux.

Here's to embracing the penguin, and the exciting Linux journey that lies ahead!
<!-- more -->
## A journey into the wold of Open-Source and GNU/Linux

There an countless resources both online and in books on shelves all around us, so why have I put this site together? Well, mostly for my own reference. As I started my journey in GNU/Linux, and as I still travel, I find myself going back to references in notebooks, books on my self, online, etc to find the materials I need. If I do that, I bet there are many others that do the same thing. This is why I am building this hub.

As noted in the intro, this site will host information of all types relating to GNU/Linux. Some will be in documentation format, others will be in blog post format.

## Breaking Free from the shackles of Proprietary Software

While the information here will mostly cover GNU/Linux, it will include topics and software related to it and will delve into the open-source world as well.

As you read on the home page, GNU/Linux is not just an Operating System but a movement that embraces transparency, rejection of vendor lock-ins and empowerment of users to shape their digital environment.

GNU/Linux stands as a beacon of freedom and collaboration, this robust and versatile OS has become the heartbeat of servers, the foundation of embedded systems, and the playground for tech enthusiasts seeking a truly customizable computing experience.

## Command Line Mystique

For the uninitiated, the command line may seem like a mysterious gateway to a digital underworld where all sort of sorcery happens. We'll try our best to unravel it's secrets and empower you to command your machine with the freedom only GNU/Linux provides.

## Welcome All

Whether you're taking your first steps into the Linux ecosystem or you're a seasoned sysadmin, this site is your companion. From beginner-friendly tutorials to advanced tips and tricks, we aim to create a space where everyone can learn, share, and revel in the beauty of Linux.

## The Journey Ahead

Together, we'll dive into the realms of distributions, explore the vast array of open-source software, and more. Linux is not just an operating system; it's a community-driven adventure waiting to unfold.

This site is not just a collection of words; it's a gateway to the expansive universe of Linux. Your insights, questions, and experiences are the building blocks of this community. Let's embark on this Linux odyssey together, celebrating the freedom to tinker, the joy of discovery, and the camaraderie of like-minded penguin aficionados.
2 changes: 1 addition & 1 deletion docs/onboarding/interface.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Let's familiarize you with the basic desktop environment and user interface commonly found in Linux distributions.

- **Desktop Environment**
- A desktop environment provides the graphical user interface (GUI) for interacting with the operating system. The most popular desktop environments in Linux include [GNOME](https://www.gnome.org/), [KDE Plasma](KDE Plasma), [Xfce](https://www.xfce.org/), [Cinnamon](https://github.com/linuxmint/Cinnamon), and [MATE](https://mate-desktop.org/). Each desktop environment offers a different look, feel, and set of features, but they typically include common elements such as a panel, menu, and system tray.
- A desktop environment provides the graphical user interface (GUI) for interacting with the operating system. The most popular desktop environments in Linux include [GNOME](https://www.gnome.org/), [KDE Plasma](https://kde.org/plasma-desktop/), [Xfce](https://www.xfce.org/), [Cinnamon](https://github.com/linuxmint/Cinnamon), and [MATE](https://mate-desktop.org/). Each desktop environment offers a different look, feel, and set of features, but they typically include common elements such as a panel, menu, and system tray.
- **Panel or Taskbar**
- The panel, also known as a taskbar or dock, is a horizontal or vertical bar that runs along the edge of the screen. It usually contains a variety of icons and applets that provide quick access to commonly used applications, system settings, and notifications. The panel may also display the date and time, a system menu, and indicators for battery life, network connectivity, and sound volume.
- **Menu**
Expand Down
39 changes: 25 additions & 14 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,27 @@ copyright: 'Copyright &copy; 2019 - Present'

# Navigation
nav:
- Home: index.md
- Home: 'index.md'
- Onboarding:
- Introduction to Linux: onboarding/intro.md
- Choosing a Distro: onboarding/choosing_distros.md
- Interface: onboarding/interface.md
- Fundamentals: onboarding/fundamentals.md
- Filestructure: onboarding/file_structure.md
- File Manipulation: onboarding/file_manipulation.md
- Filesystem Navigation: onboarding/filesystem_navigation.md
- Introduction to Linux: 'onboarding/intro.md'
- Choosing a Distro: 'onboarding/choosing_distros.md'
- Interface: 'onboarding/interface.md'
- Fundamentals: 'onboarding/fundamentals.md'
- Filestructure: 'onboarding/file_structure.md'
- File Manipulation: 'onboarding/file_manipulation.md'
- Filesystem Navigation: 'onboarding/filesystem_navigation.md'
- Baseline:
- SSH: baseline/ssh.md
- 'baseline/index.md'
- SSH: 'baseline/ssh.md'
- Blog:
- blog/index.md
- 'blog/index.md'

# <!-- START CUSTOMIZATION SECTION -->
# Documentation and theme
theme:
name: material
language: en
custom_dir: overrides
features:
- announce.dismiss
- content.code.annotate
Expand All @@ -43,6 +45,9 @@ theme:
palette:
primary: 'white'
accent: 'deep orange'
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
font:
text: 'Rubik'
code: 'JetBrains Mono'
Expand All @@ -60,7 +65,11 @@ extra_javascript:
plugins:
- search
- blog:
authors_profiles: true
authors: true
archive_date_format: MMMM yyyy
pagination: true
pagination_per_page: 5
pagination_format: "$link_first $link_previous ~2~ $link_next $link_last"
- ezlinks
- git-authors:
exclude:
Expand All @@ -72,6 +81,7 @@ plugins:
fallback_to_build_date: true
exclude:
- index.md
- glightbox

markdown_extensions:
- abbr
Expand All @@ -91,9 +101,11 @@ markdown_extensions:
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
Expand All @@ -112,7 +124,6 @@ markdown_extensions:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
format: !!python/name:pymdownx.superfences.fence_div_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
Expand Down
9 changes: 9 additions & 0 deletions overrides/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{% extends "main.html" %}

<!-- Content -->
{% block content %}
<h1>Something's Wrong Here!</h1>
<p><strong>"Resource not found 404"</strong></p>
<p>The requested resource could not be found but may be available again in the future.</p>
<p>Please use the search box above to locate the information you were looking for.</p>
{% endblock %}
3 changes: 3 additions & 0 deletions overrides/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% extends "base.html" %}
<!-- ANNOUNCMENTS -->
{% block announce %}{% endblock %}

0 comments on commit 9edf148

Please sign in to comment.