mirror of
https://mau.dev/andreijiroh-dev/website.git
synced 2024-11-25 09:53:46 +00:00
Andrei Jiroh Halili
082e39ad04
Also update README regarding licenses. Signed-off-by: Andrei Jiroh Halili <ajhalili2006@gmail.com>
68 lines
3.1 KiB
Markdown
68 lines
3.1 KiB
Markdown
# ~ajhalili2006's website
|
|
|
|
[](https://pages.dev)
|
|
[](https://mau.dev/ajhalili2006/tildeverse-web/commits)
|
|
[](https://readthedocs.org/projects/ajhalili2006/)
|
|
|
|
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.)
|
|
|
|
## 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>
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# clone the repo
|
|
# pick one on the clone URLs
|
|
glab repo clone https://mau.dev/ajhalili2006/tildeverse-web
|
|
gh repo clone ajhalili2006/ajhalili2006.github.com
|
|
git clone git@git.sr.ht:~ajhalili2006/tildeweb
|
|
|
|
# maybe do this on a feature branch
|
|
git switch -c your-git-username/your-suggestion-here
|
|
|
|
# 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
|
|
|
|
# send patches via GitLab or GitHub through the CLI
|
|
glab auth login --host "https://mau.dev" # authenticate CLI
|
|
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
|
|
|
|
# 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 tildeweb" # 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](markdown/assets/images/favicon.png) of my profile picture.
|