5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-08-03 20:21:55 +03:00

65 Commits

Author SHA1 Message Date
a461de5eba html/css: add toggle menu for TOC on narrow (mobile) screens
This hides the TOC by default on narrower screens (< 1000 px/dp) and
adds a simple toggle menu to make it pop out.

Most is handled purely through CSS, but to hide the menu when clicking
on links or when there is no TOC at all (e.g., for the index or FAQ)
we need a bit of JavaScript. There just monkey patch the asciidoc TOC
JS function to ensure we get called in the correct moment.

Further, add a modal-like "label" over the content if the TOC menu is
open, clicking on that will also close the TOC, again with pure CSS.

This also tries to improve styling and readability for mobile in
general, while I tested on many sizes, virtual devices in Firefox and
Chromiums developer mode, and also some actual smartphone, it
certainly will not yet be perfect everywhere, but it definitively
should be better than the status quo.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
05bd9f9557 html: make table overflow the x-axis automatically
This avoids that wide tables where the cell content cannot easily wrap
cause horizontal scrolling for the whole page, rather just cause that
scrolling for the table itself, so wrap in in a div and make that use
overflow-x: auto style.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
d76f4bf7af css: ensure index image doesn't overflows ovoer the screen
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
6940302e66 css: make table cell borders more lightweight
To not deflect to much from the actual content.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
4ad5d63283 css: do not differentiate visited links
Similar to PBS, as this looks rather odd for a reference documentation
that has many links.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
2f55a8ae4b css: prefer Open Sans, sans-serif for general text font
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-31 03:06:10 +02:00
015a37d34c asciidoc conf: update ceph base url for PVE 9 baseline Ceph 19.2 Squid
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-07-16 02:15:30 +02:00
ecab5895a4 asciidoc: add clickable anchor link to all headings
Works the same as in our PBS documentation and is generally common for
documentations.

Very useful for linking specific sections of the documentation in other
places. Previously, this always had to be done by getting the correct
anchor from the HTML directly via e.g. browser devtools.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
Tested-by: Max Carrara <m.carrara@proxmox.com>
2024-06-18 10:27:49 +02:00
ef466ec91a asciidoc: introduce pricing-url variable, much like pmg-docs
Seems like a pretty sensible thing to do here too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-06 18:15:30 +01:00
c2eab5cc87 docbook: render 4th section level for manpages
In the manpage output the sections get rendered as refsections, but
those only go up to level 3:

> In DocBook, RefSect3 is the lowest-level section allowed in a
> RefEntry. There is no element analogous to a Sect4.
-- https://tdg.docbook.org/tdg/4.5/refsect3

While nesting refsect3 would work output wise, the DTD schema does not
allows this, and disabling schema validation can lead to graver
issues, so rather avoid that and use a formalpara [0], a paragraph
with a title, instead, but only for the title, as the inner content
will be a simpara (simple paragraph) that cannot be nested inside a
formalpara, but the resulting rendering works out well enough.

[0]: https://tdg.docbook.org/tdg/4.5/formalpara

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 18:09:56 +01:00
a0fdba3295 css: fine-tune h4, h5, h6 headings font-sizes
Else h6 was quite a bit tinier than the actual paragraph text, and it
doesn't hurts that h4 stands a bit out more.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 17:59:31 +01:00
450dc469d9 correctly render level 5 headings
E.g., render them as h6 for the HTML output.

Level 5 headings are the +++++ ones in the full page output, in the
per-chapter outputs they are level 4 and worked fine already.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 17:59:31 +01:00
7409fad4db dblatex: update custom style with upstream changes
checked with:
diff -up /etc/asciidoc/dblatex/asciidoc-dblatex.sty asciidoc/dblatex-custom.sty

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 17:59:31 +01:00
c7a25e7c93 update docbook config
sync over from /etc/asciidoc/docbook45.conf shipped by asciidoc.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-06-24 15:01:46 +02:00
ba6ea59562 asciidoc config: work around missing icon bug
The inline icons for admotions (note, tip, warning, ...) are missing
on builts with the asciidoc package shipped by Debian Bookworm.

As workaround set the "iconsdir" attribute manually to
"/usr/share/asciidoc/icons", as recommend by the DM in the respective
Debian bug report [0].

[0]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1036030#10

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-05-18 15:46:14 +02:00
864c4d12af conf: add support for a dark mode in the documentation
this commit adds support for a dark theme that behaves similarly to
that one used by the api viewer.

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
2023-03-17 09:02:46 +01:00
067d9c3dba attrs: update cephdocs template to quincy
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-01-16 14:55:04 +01:00
e86a387380 asciidoc: fix capitalization of GmbH
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2022-11-09 14:50:25 +01:00
208543355b update Ceph codename and docs url to octopus
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-01-28 12:14:38 +01:00
d2a0a9cc74 mediawiki: load JS helper in plugin instead of including it in the html out
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-05-28 16:03:59 +02:00
4622d5b4c5 mediawiki toc: adapt to version 1.35
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-05-28 14:19:09 +02:00
706103708c mediawiki toc: code cleanup
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-05-28 14:18:30 +02:00
cf7a2acc30 asciidoc: minimally update derived docbook conf templates to work with python 3
there are a few more changes to last stable upstream asciidoc 9.1.0
release, but for now port only those over which are absolutely
necessary.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-05-13 19:18:04 +02:00
65799de02c change 'Gmbh' to 'GmbH'
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-03-16 19:22:40 +01:00
b46a49edb1 update links to the ceph docs
* use a variable instead of hardcoded url+release name
* ceph migrated to readthedocs with a minor uri change
https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/AQZJG75IST7HFDW7OB5MNCITQOVAAUR4/

Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2020-10-14 12:28:23 +02:00
6451ecbdaa html TOC: add "back to index" link
use a unicode symbol for the back arrow, should nowadays be widely
available

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-05-06 15:16:17 +02:00
cc38b9254c html: avoid horizontal overflows, break-word and limit image width
break-work affects very long lines on all widths, as pre/monospaced
elements are limited in their available width. This is only a
rendering word break, i.e., if one copies the data they will get the
original "unbroken" one.

The "max-width=100%" enforces only better visuals where space is
limited anyway.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-01-29 16:27:51 +01:00
396e1d03f2 html: use new table-of-contents (toc2) also for individual chapters
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-01-28 18:19:47 +01:00
ea17ced93d style new TOC, sans font headings, less noise for links
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-01-24 13:46:06 +01:00
237d09b998 html: slightly wider TOC for readability
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-01-22 17:04:17 +01:00
2798d126f3 pveceph: add attribute ceph_codename
To change the codename for Ceph in one place, the patch adds the
asciidoc attribute 'ceph_codename'. Replaces the outdated references to
luminous and the http -> https on the links in pveceph.adoc.

Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
2019-11-06 19:27:23 +01:00
747e99ba33 Revert "set email to office@proxmox.com"
This reverts commit b1a2cc40b7
Reqeuested, again, by Martin as it's out there for such purposes for
>15 years, so we just keep it.
2019-05-31 13:12:47 +02:00
b1a2cc40b7 set email to office@proxmox.com
Requested by Martin as the support@ address is now quite wired to the
enterprise support ticket system, and office is for more general
requests.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-05-28 15:29:48 +02:00
91ef956f9f use https for the website
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2018-09-13 09:16:13 +02:00
1ff5e4e80e thumbnail: allow to reference all images inside /images subdir
Before, we was limited to /images/screenshots/
2018-08-16 10:13:16 +02:00
789c5c57d3 use rsvg-convert instead of inkscape
we save quite a few build (reverse-)dependencies with this change
rsvg-convert is also a lot faster.
both use the same backend to process SVGs – cairo

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2017-06-29 12:15:07 +02:00
b9ff41f19f add ceph macro 2017-06-21 08:32:39 +02:00
df0649a4ba mediawiki.conf: remove useles } 2016-11-08 10:26:36 +01:00
b179764dcb fix thumbnail padding 2016-11-08 09:21:09 +01:00
aa56b7e0f6 allow float attribute for screenshots 2016-11-08 08:38:52 +01:00
ae0ad291e1 pve-html.conf: html5 backend with thumbnail support 2016-11-07 18:17:44 +01:00
2522a62449 pve-docbook.conf: docbook backend with thumbnail support 2016-11-07 17:43:09 +01:00
8c8ae22460 mediawiki.conf: implement thumbnail attribute
And install screenshot files
2016-11-07 17:43:09 +01:00
d2e80213b5 rename dasciidoc/asciidoc.js -> asciidoc/mediawiki-asciidoc.js 2016-11-07 16:47:00 +01:00
de7022fbe9 asciidoc-pve.conf: use extra asciidoc configuration file
We can define PVE related attributes here (will replace attributes.txt).
Install all asciidoc-pve config files to /usr/share/pve-doc-generator/asciidoc
2016-11-07 08:19:04 +01:00
73799de4d0 dblatex-custom.sty: fix spacing in descriptionlabel 2016-11-05 18:43:21 +01:00
9909dc0dd5 pve-dblatex.xsl: use latex \paragraph for formalpara 2016-11-05 18:41:59 +01:00
37ea112ef9 pve-dblatex.xsl: define all dblatec settings inside this file
And overwrite formalpara template, adding newline after title.
2016-11-05 12:13:42 +01:00
12c4696e3f use parbox for description labels to allow line breaks 2016-11-05 11:55:25 +01:00
9dbe49ebe4 mediawiki.conf: improve horizontal list rendering 2016-10-31 11:54:00 +01:00