website/README.md
Andrei Jiroh Halili c2acf592c5
docs(global): update dev docs and add some badges
Signed-off-by: Andrei Jiroh Halili <ajhalili2006@andreijiroh.eu.org>
2023-09-30 01:24:31 +08:00

4 KiB

~ajhalili2006's website

Hosted on pages.dev GitLab last commit Staging builds on Read The Docs Community Docker CI pipeline status

This is my sources for both andreijiroh.(eu.org|dev) and tilde userpages in Ctrl-C Club and ~vern, built with Mkdocs + Material theme by ~squidfunk. (Sources for Gemini version of the website is available at gmi directory.)

Mirrors

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

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 these links:

Open in Gitpod Open in Codespaces

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.

License

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.