docs(global): add nowpage and then some

This commit is contained in:
Andrei Jiroh Halili 2023-03-04 01:25:16 +08:00 committed by GitHub
parent 303db1f7f8
commit c6693426cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 97 additions and 21 deletions

View file

@ -1,15 +1,44 @@
# tildeverse.andreijiroh.dev + Gemini-ified blog posts
# ~ajhalili2006's website
This is my personal website in the tildeverse, built with Material Design for Mkdocs and also the
official home formy blog posts in Gemini format. Site content (exluding external content) is licensed
This is my sources for both [`andreijiroh.dev`](https://andreijiroh.eu.org) and tilde userpages in Ctrl-C Club and ~vern, built with Mkdocs + Material theme by ~squidfunk. (Sources for Gemini version of the website is available at `gmi` directory.)
Site content (exluding external content) is licensed
under CC BY-SA 4.0.
## Development
1. `git clone https://mau.dev/ajhalili2006/tildeverse-web` or `git clone git@git.sr.ht:~ajhalili2006/tildeverse-web`
2. `pip3 install -r requirements.txt`
3. `mkdocs serve`, `firefox http://localhost:8000` and `nano markdown/<whatever>.md`
4. `git commit --signoff` and `git send-email ...`
```bash
# clone the repo
# pick one on the clone URLs
git clone https://mau.dev/ajhalili2006/tildeverse-web
git clone git@git.sr.ht:~ajhalili2006/tildeverse-web
# maybe do this on a feature branch
git switch -c username/my-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 through the CLI
glab -R https://mau.dev/ajhalili2006/tildeverse-web mr create --allow-collaboration -b main
# 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"
git config format.subjectPrefix "PATCH tildeweb"
git config --global sendemail.annotate yes
git config --global format.signOff true
git send-email HEAD^
```
## Contributing