1
0
Fork
You've already forked qubes-docium
0
HOWTO for visual editing the new qubes doc utilizing codium
  • Shell 100%
2025年09月12日 18:03:19 +02:00
doc update doc and scripts to use https://github.com/QubesOS/qubes-doc.git 2025年09月12日 18:03:19 +02:00
qmbadmin make the qmbadmin scripts generic 2025年09月01日 11:32:33 +02:00
qube update doc and scripts to use https://github.com/QubesOS/qubes-doc.git 2025年09月12日 18:03:19 +02:00
template update 2025年08月28日 17:28:40 +02:00
README.md readme: fix links 2025年09月01日 11:55:48 +02:00

qubes-docium

little writeup 'bout my qubes doc editing setup.
following this instructions should leave you with a working GUI editor for the new qubes documentation (read the docs).

Would be nice to have a template (or package?) for this. Until it exists, you have to setup it by yourself.

For more notes and setup variants see qubes forum or FORUM.md at codeberg or local

A script for automated setup can be found in the qmbadmin folder.

matrix room: #qubism:c-base.org

preparation step1

clone an offical template.
this guide is build with fedora-42-xfce, minimal may require additional dependencies installed (not testet).

qvm-clone fedora-42-xfce qmb-docium-template

preparation step2

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 copy the template configuration files into the new template qube.

cd qubes-docium/template
qvm-copy fedora

template configuration

now open a terminal in the new template

cd ~/QubesIncoming/<sourceqube>/fedora
./setup.sh

the script will shut down the template if done.

docium qube

create a new qube based on the new template.
give it some more storage. the default 2G might be enougth, >5G should be plenty.

create a project folder and cd into it.
clone the repository again

git clone https://codeberg.org/saces/qubes-docium

or move the qubes-docium folder from your usual work/devel qube here.

cd qubes-docium/qube
./setup-codium.sh
./setup-doc-repos.sh
./run-codium.sh

Its the first codium start, just click 'Trust the Authors', ignore anything else. Let it settle a bit, close codium.
Start it again

./run-codium.sh

Voilà, ready to edit. Open a rst file, enable the previev and wait for the rendered doc to appear...