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