mirror of
https://mau.dev/andreijiroh-dev/website.git
synced 2024-11-12 20:32:26 +00:00
81bcc565c1
Adopted from @Xe's website repository, I added the section "Information for people wishing to use this repository" to help guide potential users who plan to fork the repo for their use to consider things to do first, among other possible legalese things. Signed-off-by: Andrei Jiroh Halili <ajhalili2006@andreijiroh.eu.org>
105 lines
5.6 KiB
Markdown
105 lines
5.6 KiB
Markdown
# ~ajhalili2006's website
|
|
|
|
[](https://pages.dev)
|
|
[](https://mau.dev/andreijiroh.dev/website/commits)
|
|
[](https://readthedocs.org/projects/ajhalili2006/)
|
|
[](https://github.com/ajhalili2006/ajhalili2006.github.io/actions/workflows/docker.yml?query=event%3Aschedule)
|
|
[](https://mau.dev/andreijiroh.dev/website/-/pipelines)
|
|
|
|
This is my sources for both [`andreijiroh.(eu.org|dev)`](https://andreijiroh.eu.org) and tilde userpages,
|
|
built with Mkdocs + [Material theme](https://go.andreijiroh.eu.org/mkdocs-material) by
|
|
[~squidfunk](https://github.com/squidfunk). Sources for Gemini version of the website is
|
|
available at `gmi` directory.
|
|
|
|
## Information for people wishing to use this repository
|
|
|
|
While this is fairly just static site (with CI configs and even Cloudflare Pages references)
|
|
and not licensed under the Zlib license ([context from Xe/site repo][zlib-chaos]), please don't
|
|
just fork this repo unless you know what you're REALLY doing.
|
|
|
|
[zlib-chaos]: https://github.com/Xe/site/blob/HEAD/README.md#information-for-people-wishing-to-use-this-code
|
|
|
|
If you're pretty serious, please keep several things in mind:
|
|
|
|
- You must heavily edit the Markdown content of the website. Make your own personal user manual and portfolio,
|
|
or heck even go nuts on the homepage.[^1]
|
|
- Blog posts I written in Gemini version are licensed under CC-BY-SA-4.0,
|
|
[as mentioned below](#legalese) unless specified otherwise.
|
|
But [for the love of god], please use your own blog posts when writing for
|
|
Gemini users instead.
|
|
- For the favicon, use your own profile picture or pick/make another one.
|
|
|
|
[for the love of god]: https://english.stackexchange.com/questions/351296/what-exactly-does-for-the-love-of-god-mean#351326
|
|
[^1]: Please keep it SFW, since you don't want to get that censored by the MTRCB, right?
|
|
|
|
**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)
|
|
with some fine defaults, alongside a blog section if you prefer.
|
|
|
|
## Mirrors
|
|
|
|
Canonically developed at [mau.dev](https://mau.dev/andreijiroh.dev/website.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> (repository clone URL: `git.jetbrains.space/ajhalili2006/web/andreijiroh.dev.git`)
|
|
* Sourcehut: <https://git.sr.ht/~ajhalili2006/web>
|
|
|
|
## Site Development
|
|
|
|
Use the clone links from either the canonical repository URL or its mirrors
|
|
[as mentioned above](#mirrors) or open this repo in a cloud development
|
|
environment using these links:
|
|
|
|
[](https://gitpod.io/#https://mau.dev/andreijiroh.dev/website)
|
|
[](https://codespaces.new/ajhalili2006/ajhalili2006.github.io)
|
|
|
|
### Building from source
|
|
|
|
```bash
|
|
# 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
|
|
|
|
|
|
```bash
|
|
# 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.
|
|
|
|
## Legalese
|
|
|
|
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 (current) profile picture.
|
|
|
|
### Third-party code
|
|
|
|
* [OpenWeb Icons Set](https://iconduck.com/sets/openweb-icons-set) - SIL Open Font License 1.1
|
|
* Upstream template code from Material for Mkdocs for overrides directory - MIT
|