> NOTE: This document is shared between platforms, so image links are either broken in the forum or in the repository/local view. Sorry for the inconvenience.
little writeup 'bout my qubes doc editing setup.
It's basicly VSCodium with a bunch of fancy extensions to preview the qubes doc side by side
and editing images with excalidraw
If you are already using VSCodium (MSCode works too) you need to install the extensions as shown in the screenshot above. Click them or use the cli:
codium --install-extension ms-python.python
codium --install-extension chrisjsewell.myst-tml-syntax
codium --install-extension swyddfa.esbonio --pre-release
codium --install-extension trond-snekvik.simple-rst
codium --install-extension lextudio.restructuredtext
codium --install-extension pomdtr.excalidraw-editor
In an ideal world you would be done now, but…
The patches required to have the preview working are in my private fork: https://codeberg.org/saces/qubes-doc
Use it in a bare directory
mkdir docium
cd docium
git clone https://codeberg.org/saces/qubes-doc .
codium .
git remote add docium https://codeberg.org/saces/qubes-doc.git
git fetch docium docium
…
This repository is push -f'ed each time I sync with upstream, so my changes are always on top.
Add codium to your template, App or DistVM…
- debian: https://forum.qubes-os.org/t/installing-visual-studio-code-unity-securely/11219/2
- fedora: dnf config-manager addrepo --from-repofile=https://codeberg.org/saces/qubes-docium/raw/branch/main/template/fedora/vscodium.repos & dnf install codium
Two scripts for creating a fedora based template and appvm are found here: https://codeberg.org/saces/qubes-docium/src/branch/main/qmbadmin.
They are written for the AppVM I'm working from (remember the first rule of the qubes club: You shall not work in Dom0!) and everything is either default or hardcoded, so you must review and adjust them before running them.
this is done in your usual work/devel/disposal qube with git installed.
clone this repository:
git clone https://codeberg.org/saces/qubes-docium
and transfer it to Dom0 or your AdminAppVM.
Run the following steps there you the repository tranfered to.
cd qmbadmin
No parameters yet, so it creates a template qmb-docium-template based upon fedora-42-xfce.
Usage:
setup-template.sh
Next TODO: make it work in Dom0
No parameters yet, so it creates a purple appvm qmb-docium with template qmb-docium-template.
Usage:
setup-appvm.sh
Next TODO: make it work in Dom0
TODO: add a script that does the initial configuration for the not so geeky user
TODO: add a convience script that starts a console and codium with tho doc open.
I prefer matrix: #qubism:c-base.org, forum will work too.
If you created patches and don't have a codeberg.org account, just publish them and send me the url so I can pick them up or send patch or bundle files via matrix for incorperating them. Many thanks!.