Skip to content

Latest commit

 

History

History
109 lines (79 loc) · 5.81 KB

README.md

File metadata and controls

109 lines (79 loc) · 5.81 KB
Raw

~ajhalili2006's website

Hosted on pages.dev Open in Gitpod Open in Codespaces GitLab last commit Staging builds on Read The Docs Community Docker Image Builds GitLab CI status

This is my sources for both andreijiroh.dev and tilde userpages, built with Mkdocs + Material theme by ~squidfunk. Sources for Gemini version of the website is available at gmi directory.

Information for people wishing to use this repository

While this is fairly just static site (with CI configs and even Cloudflare Pages references) and not licensed under the Zlib license (context from Xe/site repo), please don't just fork this repo unless you know what you're REALLY doing.

If you're pretty serious, please keep several things in mind:

  • You must heavily edit the Markdown content of the website. Make your own personal user manual and portfolio, or heck even go nuts on the homepage.1
  • Blog posts I written in Gemini version are licensed under CC-BY-SA-4.0, as mentioned below unless specified otherwise. But for the love of god, please use your own blog posts when writing for Gemini users instead.
  • For the favicon, use your own profile picture or pick/make another one.

Looking for a template instead with same Mkdocs theme? No problem! I contributed one at lorebooks.wiki's GitHub org with some fine defaults, alongside a blog section if you prefer.

Mirrors

Canonically developed at mau.dev where the deployments happen, with the following mirrors being maintained:

Structure

  • markdown - the source Markdown files for the website
  • [overrides] - theme customizations and Mkdocs build hooks in Python

Site Development

Use the clone links from either the canonical repository URL or its mirrors as mentioned above or open this repo in a cloud development environment using the open in links above.

Building from source

# install deps via pipenv...
pipenv install
# ...or via pip3 with --user -flag (generated from "pipenv requirements" and sending its output
# to requirements.txt)
pip install -r requirements.txt --user

# preview site and edit in another session
mkdocs serve --watch overrides --watch-theme --livereload

Sending patches

# send patches via GitLab or GitHub through the CLI
glab auth login --host "https://mau.dev" # authenticate CLI
gh auth login # authenticate CLI, GitHub.com edition
glab -R https://mau.dev/andreijiroh.dev/website mr create --allow-collaboration -b main
gh -R ajhalili2006/tildeverse-web pr create # might automatically closes PR due to mirror status

# or via my public inbox on sourcehut
# see https://git-send-email.io for setup and guide
git config sendemail.to "~ajhalili2006/public-inbox@lists.sr.ht" # NOT my personal email
git config format.subjectPrefix "PATCH web" # identification in archives + builds.sr.ht
git config --global sendemail.annotate yes
git config --global format.signOff true # needed for compliance with Linux DCO
git send-email HEAD^

Contributing

Patches are always welcome, although you must sign-off your commits to comply with the Linux DCO. Please be reminded that while this is a personal open-source project, please expect long waiting times during pathc reviews and don't be disappointed when I disagree on stuff and chose not to merge the patches for any reasons, including mental health breaks.

Legalese

Unless otherwise noted, source code is licensed under the MPL-2.0 while website content (text-only) is under CC BY-SA 4.0.

The only thing that's not covered by this is the favicon version of my (current) profile picture.

Third-party code

Footnotes

  1. Please keep it SFW, since you don't want to get that censored by the MTRCB, right? ↩