commit c2acf592c5d67cc7432dc3294e9a2abe9e91dbd0 · andreijiroh.dev/site

+28 -24

README.md

···

       15
       15
        
       Canonically developed at [mau.dev](https://mau.dev/andreijiroh.dev/website.git) where the deployments happen, with the following mirrors being maintained:

     

       16
       16
        
       

     

       17
       17
        
       * GitHub: <https://github.com/ajhalili2006/ajhalili2006.github.io.git>, where Docker image builds happen

     

       18
       18
       -
       * Jetbrains Space (personal): <https://ajhalili2006.jetbrains.space/p/web/repositories/andreijiroh.dev/files/README.md>

     

       19
       19
       -
       * Sourcehut: <https://git.sr.ht/~ajhalili2006/tildeweb>

     

       18
       18
       +
       * Jetbrains Space (personal): <https://ajhalili2006.jetbrains.space/p/web/repositories/andreijiroh.dev> (repository clone URL: `git.jetbrains.space/ajhalili2006/web/andreijiroh.dev.git`)

     

       19
       19
       +
       * Sourcehut: <https://git.sr.ht/~ajhalili2006/web>

     

       20
       20
        
       

     

       21
       21
       -
       ## Development

     

       21
       21
       +
       ## Site Development

     

       22
       22
        
       

     

       23
       23
       -
       ```bash

     

       24
       24
       -
       # clone the repo

     

       25
       25
       -
       # pick one on the clone URLs

     

       26
       26
       -
       glab repo clone https://mau.dev/ajhalili2006/tildeverse-web

     

       27
       27
       -
       gh repo clone ajhalili2006/ajhalili2006.github.com

     

       28
       28
       -
       git clone git@git.sr.ht:~ajhalili2006/tildeweb

     

       23
       23
       +
       Use the clone links from either the canonical repository URL or its mirrors

     

       24
       24
       +
       [as mentioned above](#mirrors) or open this repo in a cloud development

     

       25
       25
       +
       environment using these links:

     

       29
       26
        
       

     

       30
       30
       -
       # maybe do this on a feature branch

     

       31
       31
       -
       git switch -c your-git-username/your-suggestion-here

     

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

     

       32
       29
        
       

     

       33
       33
       -
       # install deps via venv

     

       34
       34
       -
       python3 -m venv venv

     

       35
       35
       -
       source ./venv/bin/activate

     

       36
       36
       -
       pip3 install -r requirements.txt

     

       30
       30
       +
       ### Building from source

     

       31
       31
       +
       

     

       32
       32
       +
       ```bash

     

       33
       33
       +
       # install deps via pipenv...

     

       34
       34
       +
       pipenv install

     

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

     

       36
       36
       +
       # to requirements.txt)

     

       37
       37
       +
       pip install -r requirements.txt --user

     

       37
       38
        
       

     

       38
       39
        
       # preview site and edit in another session

     

       39
       39
       -
       mkdocs serve

     

       40
       40
       -
       nano markdown/path-to-file.md

     

       40
       40
       +
       mkdocs serve --watch overrides --watch-theme --livereload

     

       41
       41
       +
       ```

     

       41
       42
        
       

     

       42
       42
       -
       # done?

     

       43
       43
       -
       git stage . && git commit --signoff

     

       43
       43
       +
       ### Sending patches

     

       44
       44
       +
       

     

       44
       45
        
       

     

       46
       46
       +
       ```bash

     

       45
       47
        
       # send patches via GitLab or GitHub through the CLI

     

       46
       48
        
       glab auth login --host "https://mau.dev" # authenticate CLI

     

       47
       47
       -
       glab -R https://mau.dev/ajhalili2006/tildeverse-web mr create --allow-collaboration -b main

     

       49
       49
       +
       gh auth login # authenticate CLI, GitHub.com edition

     

       50
       50
       +
       glab -R https://mau.dev/andreijiroh.dev/website mr create --allow-collaboration -b main

     

       48
       51
        
       gh -R ajhalili2006/tildeverse-web pr create # might automatically closes PR due to mirror status

     

       49
       52
        
       

     

       50
       53
        
       # or via my public inbox on sourcehut

     

       51
       54
        
       # see https://git-send-email.io for setup and guide

     

       52
       55
        
       git config sendemail.to "~ajhalili2006/public-inbox@lists.sr.ht" # NOT my personal email

     

       53
       53
       -
       git config format.subjectPrefix "PATCH tildeweb" # identification in archives + builds.sr.ht

     

       56
       56
       +
       git config format.subjectPrefix "PATCH web" # identification in archives + builds.sr.ht

     

       54
       57
        
       git config --global sendemail.annotate yes

     

       55
       58
        
       git config --global format.signOff true # needed for compliance with Linux DCO

     

       56
       59
        
       git send-email HEAD^

     
···

       65
       68
        
       

     

       66
       69
        
       ## License

     

       67
       70
        
       

     

       68
       68
       -
       Unless otherwise noted, source code is licensed under the MPl-2.0 while website content (text-only)

     

       69
       69
       -
       is under CC BY-SA 4.0

     

       71
       71
       +
       Unless otherwise noted, source code is licensed under the MPL-2.0 while website content (text-only)

     

       72
       72
       +
       is under CC BY-SA 4.0.

     

       70
       73
        
       

     

       71
       71
       -
       The only thing that's not covered by this is [the favicon version](markdown/assets/images/favicon.png) of my profile picture.

     

       74
       74
       +
       The only thing that's not covered by this is [the favicon version](markdown/assets/images/favicon.png)

     

       75
       75
       +
       of my (current) profile picture.

+6 -8

docker/README.md

···

       1
       1
       -
       # CI image for GitLab CI deploys

     

       1
       1
       +
       # Custom `mkdocs-material` CI image

     

       2
       2
        
       

     

       3
       3
       -
       This directory contains the necessary files to build a container image for the website deployments.

     

       4
       4
       -
       

     

       5
       5
       -
       ## How to build

     

       3
       3
       +
       Builds on Alpine edge, mostly used by @ajhalili2006 to deploy

     

       4
       4
       +
       builds over GitLab Ci.

     

       6
       5
        
       

     

       7
       7
       -
       Just run the script to build locally

     

       6
       6
       +
       ## Build from source

     

       8
       7
        
       

     

       9
       9
       -
       ```bash

     

       10
       10
       -
       ./docker/build.sh

     

       11
       11
       -
       ```

     

       8
       8
       +
       After cloning [Andrei Jiroh's website sources](https://mau.dev/andreijiroh.dev/website), you can run the `build.sh` script

     

       9
       9
       +
       (see script source for available options)