What is the documentation built on?

User Support
1

The official linux documentation The Linux Kernel documentation — The Linux Kernel documentation is built on Overview — Sphinx documentation

What is Qubes doc built on?

2

it seem not based on anything, just plain text markdown

3

On the shoulders of giants, my friend. On the shoulders of giants.

… on the Git platform using markup files.

1 Like
4

Not much info here but it’s a custom theme for a github.io site.

5

Yeah but from .md to html there must be something, or am I missing something?

What if I wanted to run a local server of the qubes-doc? What should I do?

6

Fedora

sudo dnf install ruby ruby-devel openssl-devel redhat-rpm-config @development-tools

Debian

sudo apt-get install ruby-full build-essential

Follow these

git clone --recursive https://github.com/QubesOS/qubesos.github.io.git qubesos-doc
cd qubesos-doc
bundle exec jekyll serve
http://localhost:4000
7

Are you asking how to publish a webpage? Try Github Pages or Jekyll or searching for ways to publish Github Markdown files to a simple website. I’m not sure I understand what you’re asking.

edit: Just saw @51lieal’s reply. There ya go.

8

Or you could check the README here -

The “official” way is using podman, as detailed on that page.
You need to use git clone -recursive, I think.
Either route will generate a static site and serve it locally.

If you only want the docs, rather than the full site, they are written in
Markdown, which you can just read in any text editor.
Those pages are available from GitHub - QubesOS/qubes-doc: Qubes documentation, as
has been said.

There’s a 6 year old open issue about providing offline documentation -
all contributions welcome

I never presume to speak for the Qubes team.
When I comment in the Forum or in the mailing lists I speak for myself.
3 Likes
9

yeah you’re right since there’s a submodules. i’ll edit thanks for clarifying.

10

I think yours is what I was searching for. Thanks everyone!