qubes-docium
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 setup for editing the new read-the-docs version of the qubes doc (forum-doc-announcement)
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
Done. Now open the rst files in codium…
Install VSCodium
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
Create A Template and AppVM
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 initially for the AppVM I’m working from (remember the first rule of the qubes club: You shall not work in Dom0!), they should work in such an environment and from Dom0.
Obtaining The Scripts
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
setup-template.sh
Usage:
setup-template.sh TEMPLATE NEW_TEMPLATE
Example: setup-template.sh fedora-42-xfce qmb-docium-template
setup-appvm.sh
Usage:
setup-appvm.sh TEMPLATE APPVM LABEL
Example: setup-appvm.sh qmb-docium-template qmb-docium purple
docium-firststart.sh
TODO: add a script that does the initial configuration for the not so geeky user
docium-start.sh
TODO: add a convience script that starts a console and codium with tho doc open.
Contact and Patches
I prefer matrix: #qubism:c-base.org, forum and other channels 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 incorporating them. Many thanks!.