andreijiroh.dev / site
~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
zensical mkdocs-material website
fork atom

docs(readme): update badge and some new docs

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>

Andrei Jiroh Halili 81bcc565 88ed9471

options
unified split
Changed files
+31 -6
README.md
+31 -6
README.md 
···

       
4

       
 

       
[![GitLab last commit](https://img.shields.io/gitlab/last-commit/andreijiroh.dev/website?gitlab_url=https%3A%2F%2Fmau.dev&style=flat-square)](https://mau.dev/andreijiroh.dev/website/commits)


     

       
5

       
 

       
[![Staging builds on Read The Docs Community](https://readthedocs.org/projects/ajhalili2006/badge/?version=latest&style=flat-square)](https://readthedocs.org/projects/ajhalili2006/)


     

       
6

       
 

       
[![Docker CI](https://github.com/ajhalili2006/ajhalili2006.github.io/actions/workflows/docker.yml/badge.svg?event=schedule&style=flat-badge)](https://github.com/ajhalili2006/ajhalili2006.github.io/actions/workflows/docker.yml?query=event%3Aschedule)


     

       
7

       
-

       
[![pipeline status](https://mau.dev/andreijiroh.dev/website/badges/main/pipeline.svg?style=flat-square)](https://mau.dev/andreijiroh.dev/website/-/pipelines)


     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       
8

       
 

       



     

       
9

       
-

       
This is my sources for both [`andreijiroh.(eu.org|dev)`](https://andreijiroh.eu.org) and tilde userpages in Ctrl-C Club and ~vern,


     

       
10

       
-

       
built with Mkdocs + [Material theme](https://go.andreijiroh.eu.org/mkdocs-material) by [~squidfunk](https://go.andreijiroh.eu.org/squidfunk).


     

       
11

       
-

       
(Sources for Gemini version of the website is available at `gmi` directory.)


     

       

       

       
     

       

       

       
     

       
12

       
 

       



     

       
13

       
 

       
## Mirrors


     

       
14

       
 

       



     
···

       
25

       
 

       
environment using these links:


     

       
26

       
 

       



     

       
27

       
 

       
[![Open in Gitpod](https://img.shields.io/badge/open%20in-Gitpod-orange?style=flat-square&logo=gitpod)](https://gitpod.io/#https://mau.dev/andreijiroh.dev/website)


     

       
28

       
-

       
[![Open in Codespaces](https://img.shields.io/badge/open%20in-Codespaces-black?style=flat-square&logo=github)](https://codespaces.dev/ajhalili2006/ajhalili2006.github.io)


     

       
29

       
 

       



     

       
30

       
 

       
### Building from source


     

       
31

       
 

       



     

       
32

       
 

       
```bash


     

       
33

       
 

       
# install deps via pipenv...


     

       
34

       
 

       
pipenv install


     

       
35

       
-

       
# ...or via pip3 with --user flag (generated from "pipenv requirements" and sending its output


     

       
36

       
 

       
# to requirements.txt)


     

       
37

       
 

       
pip install -r requirements.txt --user


     

       
38

       
 

       



     
···

       
4

       
 

       
[![GitLab last commit](https://img.shields.io/gitlab/last-commit/andreijiroh.dev/website?gitlab_url=https%3A%2F%2Fmau.dev&style=flat-square)](https://mau.dev/andreijiroh.dev/website/commits)


     

       
5

       
 

       
[![Staging builds on Read The Docs Community](https://readthedocs.org/projects/ajhalili2006/badge/?version=latest&style=flat-square)](https://readthedocs.org/projects/ajhalili2006/)


     

       
6

       
 

       
[![Docker CI](https://github.com/ajhalili2006/ajhalili2006.github.io/actions/workflows/docker.yml/badge.svg?event=schedule&style=flat-badge)](https://github.com/ajhalili2006/ajhalili2006.github.io/actions/workflows/docker.yml?query=event%3Aschedule)


     

       
7

       
+

       
[![GitLab CI status](https://mau.dev/andreijiroh.dev/website/badges/main/pipeline.svg?style=flat-square)](https://mau.dev/andreijiroh.dev/website/-/pipelines)


     

       
8

       
+

       



     

       
9

       
+

       
This is my sources for both [`andreijiroh.(eu.org|dev)`](https://andreijiroh.eu.org) and tilde userpages,


     

       
10

       
+

       
built 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


     

       
12

       
+

       
available at `gmi` directory.


     

       
13

       
+

       



     

       
14

       
+

       
## Information for people wishing to use this repository


     

       
15

       
+

       



     

       
16

       
+

       
While this is fairly just static site (with CI configs and even Cloudflare Pages references)


     

       
17

       
+

       
and not licensed under the Zlib license ([context from Xe/site repo][zlib-chaos]), please don't


     

       
18

       
+

       
just 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

       
+

       



     

       
22

       
+

       
If 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,


     

       
25

       
+

       
or 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.


     

       
28

       
+

       
But [for the love of god], please use your own blog posts when writing for


     

       
29

       
+

       
Gemini 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)


     

       
36

       
+

       
with some fine defaults, alongside a blog section if you prefer.


     

       
37

       
 

       



     

       
38

       
 

       
## Mirrors


     

       
39

       
 

       



     
···

       
50

       
 

       
environment using these links:


     

       
51

       
 

       



     

       
52

       
 

       
[![Open in Gitpod](https://img.shields.io/badge/open%20in-Gitpod-orange?style=flat-square&logo=gitpod)](https://gitpod.io/#https://mau.dev/andreijiroh.dev/website)


     

       
53

       
+

       
[![Open in Codespaces](https://img.shields.io/badge/open%20in-Codespaces-black?style=flat-square&logo=github)](https://codespaces.new/ajhalili2006/ajhalili2006.github.io)


     

       
54

       
 

       



     

       
55

       
 

       
### Building from source


     

       
56

       
 

       



     

       
57

       
 

       
```bash


     

       
58

       
 

       
# install deps via pipenv...


     

       
59

       
 

       
pipenv install


     

       
60

       
+

       
# ...or via pip3 with --user -flag (generated from "pipenv requirements" and sending its output


     

       
61

       
 

       
# to requirements.txt)


     

       
62

       
 

       
pip install -r requirements.txt --user


     

       
63