2023-03-03 17:25:16 +00:00
# ~ajhalili2006's website
2022-10-21 17:34:59 +00:00
2023-09-24 01:22:45 +00:00
[![Hosted on pages.dev ](https://img.shields.io/badge/hosted%20on-pages.dev-orange?style=flat-square&logo=cloudflare )](https://pages.dev)
[![GitLab last commit ](https://img.shields.io/gitlab/last-commit/ajhalili2006/tildeverse-web?gitlab_url=https%3A%2F%2Fmau.dev&style=flat-square )](https://mau.dev/ajhalili2006/tildeverse-web/commits)
[![RTFD.io ](https://readthedocs.org/projects/ajhalili2006/badge/?version=latest&style=flat-square )](https://readthedocs.org/projects/ajhalili2006/)
2023-03-03 17:25:16 +00:00
2023-05-05 09:24:28 +00:00
This is my sources for both [`andreijiroh.(eu.org|dev)` ](https://andreijiroh.eu.org ) and tilde userpages in Ctrl-C Club and ~vern,
built with Mkdocs + [Material theme ](https://go.andreijiroh.eu.org/mkdocs-material ) by [~squidfunk ](https://go.andreijiroh.eu.org/squidfunk ).
(Sources for Gemini version of the website is available at `gmi` directory.)
2022-12-26 17:28:16 +00:00
2023-07-15 16:56:29 +00:00
## Mirrors
Canonically developed at [mau.dev ](https://mau.dev/ajhalili2006/tildeverse-web.git ) where the deployments happen, with the following mirrors being maintained:
* GitHub: < https: // github . com / ajhalili2006 / ajhalili2006 . github . io . git > , where Docker image builds happen
* Jetbrains Space (personal): < https: // ajhalili2006 . jetbrains . space / p / web / repositories / andreijiroh . dev / files / README . md >
2022-12-26 17:28:16 +00:00
## Development
2023-03-03 17:25:16 +00:00
```bash
# clone the repo
# pick one on the clone URLs
2023-05-05 09:24:28 +00:00
glab repo clone https://mau.dev/ajhalili2006/tildeverse-web
2023-07-15 16:56:29 +00:00
gh repo clone ajhalili2006/ajhalili2006.github.com
2023-05-05 09:24:28 +00:00
git clone git@git.sr.ht:~ajhalili2006/tildeweb
2023-03-03 17:25:16 +00:00
# maybe do this on a feature branch
2023-05-05 09:24:28 +00:00
git switch -c your-git-username/your-suggestion-here
2023-03-03 17:25:16 +00:00
# install deps via venv
python3 -m venv venv
source ./venv/bin/activate
pip3 install -r requirements.txt
# preview site and edit in another session
mkdocs serve
nano markdown/path-to-file.md
# done?
git stage . & & git commit --signoff
2023-05-05 09:24:28 +00:00
# send patches via GitLab or GitHub through the CLI
2023-07-15 16:56:29 +00:00
glab auth login --host "https://mau.dev" # authenticate CLI
2023-05-05 09:24:28 +00:00
glab -R https://mau.dev/ajhalili2006/tildeverse-web mr create --allow-collaboration -b main
gh -R ajhalili2006/tildeverse-web pr create # might automatically closes PR due to mirror status
2023-03-03 17:25:16 +00:00
# or via my public inbox on sourcehut
# see https://git-send-email.io for setup and guide
2023-07-15 16:56:29 +00:00
git config sendemail.to "~ajhalili2006/public-inbox@lists.sr.ht" # NOT my personal email
2023-05-05 09:24:28 +00:00
git config format.subjectPrefix "PATCH tildeweb" # identification in archives + builds.sr.ht
2023-03-03 17:25:16 +00:00
git config --global sendemail.annotate yes
2023-05-05 09:24:28 +00:00
git config --global format.signOff true # needed for compliance with Linux DCO
2023-03-03 17:25:16 +00:00
git send-email HEAD^
```
2022-10-21 17:34:59 +00:00
## Contributing
Patches are always welcome, although you must sign-off your commits to comply with the Linux DCO.
2022-12-26 17:28:16 +00:00
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.
2023-05-05 09:24:28 +00:00
## License
Unless otherwise noted,
The only thing that's not covered by this is [the favicon version ](markdown/assets/images/favicon.png ) of my profile picture.