~ajhalili2006's personal website, built with Zensical (successor of Material for Mkdocs) [old repo name got bugged while attempting to do manual knot migration via repo deletion]
andreijiroh.dev
andreijiroh.dev
zensical
mkdocs-material
website
1# ~ajhalili2006's website
2
3[](https://pages.dev)
4[](https://mau.dev/andreijiroh.dev/website/commits)
5[](https://readthedocs.org/projects/ajhalili2006/)
6[](https://github.com/andreijiroh-dev/docker-images/actions/workflows/docker-buildops.yml)
7[](https://mau.dev/andreijiroh.dev/website/-/pipelines)
8
9This is my sources for both [`andreijiroh.xyz`](https://andreijiroh.xyz) and tilde userpages,
10built with Mkdocs + [Material theme](https://go.andreijiroh.eu.org/mkdocs-material) by
11[~squidfunk](https://github.com/squidfunk). Sources for Gemini version of the website is
12available at `gmi` directory.
13
14## Information for people wishing to use this repository
15
16While this is fairly just static site (with CI configs and even Cloudflare Pages references)
17and not licensed under the Zlib license ([context from Xe/site repo][zlib-chaos]), please don't
18just fork this repo unless you know what you're REALLY doing.
19
20[zlib-chaos]: https://github.com/Xe/site/blob/HEAD/README.md#information-for-people-wishing-to-use-this-code
21
22If you're pretty serious, please keep several things in mind:
23
24- You must heavily edit the Markdown content of the website. Make your own personal user manual and portfolio,
25or heck even go nuts on the homepage.[^1]
26- Blog posts I written in Gemini version are licensed under CC-BY-SA-4.0,
27[as mentioned below](#legalese) unless specified otherwise.
28But [for the love of god], please use your own blog posts when writing for
29Gemini users instead.
30- For the favicon, use your own profile picture or pick/make another one.
31
32[for the love of god]: https://english.stackexchange.com/questions/351296/what-exactly-does-for-the-love-of-god-mean#351326
33[^1]: Please keep it SFW, since you don't want to get that censored by the MTRCB, right?
34
35**Looking for a template instead with same Mkdocs theme?** No problem! [I contributed one at lorebooks.wiki's GitHub org](https://github.com/lorebooks-wiki/mkdocs-material-template)
36with some fine defaults, alongside a blog section if you prefer.
37
38## Mirrors
39
40Canonically developed at [mau.dev](https://mau.dev/andreijiroh-dev/website.git) where the deployments happen, with the following mirrors being maintained:
41
42* GitHub: <https://github.com/andreijiroh-dev/website>, where Docker image builds happen
43* Jetbrains Space (personal): <https://ajhalili2006.jetbrains.space/p/web/repositories/andreijiroh.dev> (repository clone URL: `git.jetbrains.space/ajhalili2006/web/andreijiroh.dev.git`)
44* Sourcehut: <https://git.sr.ht/~ajhalili2006/web>
45
46## Site Development
47
48Use the clone links from either the canonical repository URL or its mirrors
49[as mentioned above](#mirrors) or open this repo in a cloud development
50environment using these links:
51
52[](https://gitpod.io/#https://mau.dev/andreijiroh-dev/website)
53[](https://codespaces.new/andreijiroh-dev/website)
54
55### Building from source
56
57```bash
58# install deps via pipenv...
59pipenv install
60# ...or via pip3 with --user -flag (generated from "pipenv requirements" and sending its output
61# to requirements.txt)
62pip install -r requirements.txt --user
63
64# preview site and edit in another session
65mkdocs serve --watch overrides --watch-theme --livereload
66```
67
68### Sending patches
69
70
71```bash
72# send patches via GitLab or GitHub through the CLI
73glab auth login --host "https://mau.dev" # authenticate CLI
74gh auth login # authenticate CLI, GitHub.com edition
75glab -R https://mau.dev/andreijiroh.dev/website mr create --allow-collaboration -b main
76gh -R ajhalili2006/tildeverse-web pr create # might automatically closes PR due to mirror status
77
78# or via my public inbox on sourcehut
79# see https://git-send-email.io for setup and guide
80git config sendemail.to "~ajhalili2006/public-inbox@lists.sr.ht" # NOT my personal email
81git config format.subjectPrefix "PATCH web" # identification in archives + builds.sr.ht
82git config --global sendemail.annotate yes
83git config --global format.signOff true # needed for compliance with Linux DCO
84git send-email HEAD^
85```
86
87## Contributing
88
89Patches are always welcome, although you must sign-off your commits to comply with the Linux DCO.
90Please be reminded that while this is a personal open-source project, please expect long waiting
91times during pathc reviews and don't be disappointed when I disagree on stuff and chose not to merge
92the patches for any reasons, including mental health breaks.
93
94## Legalese
95
96Unless otherwise noted, source code is licensed under the MPL-2.0 while website content (text-only)
97is under CC BY-SA 4.0.
98
99The only thing that's not covered by this is [the favicon version](markdown/assets/images/favicon.png)
100of my (current) profile picture.
101
102### Third-party code
103
104* [OpenWeb Icons Set](https://iconduck.com/sets/openweb-icons-set) ([source code](https://github.com/pfefferle/openwebicons?ref=iconduck.com))- [SIL Open Font License 1.1](https://github.com/pfefferle/openwebicons/blob/main/License.txt)
105* Upstream template code from Material for Mkdocs for overrides directory - MIT