From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pmg-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
by lore.proxmox.com (Postfix) with ESMTPS id B1FBE1FF15D
for <inbox@lore.proxmox.com>; Thu, 8 Aug 2024 14:08:15 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id B70C01DAA9;
Thu, 8 Aug 2024 14:08:25 +0200 (CEST)
Date: Thu, 8 Aug 2024 14:07:51 +0200
From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: Christoph Heiss <c.heiss@proxmox.com>
Message-ID: <20240808140751.523374a0@rosa.proxmox.com>
In-Reply-To: <20240618094824.570620-1-c.heiss@proxmox.com>
References: <20240618094824.570620-1-c.heiss@proxmox.com>
X-Mailer: Claws Mail 4.1.1 (GTK 3.24.38; x86_64-pc-linux-gnu)
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.073 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
Subject: [pmg-devel] applied: [PATCH docs] asciidoc: add clickable anchor
link to all headings
X-BeenThere: pmg-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Mail Gateway development discussion
<pmg-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pmg-devel>,
<mailto:pmg-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pmg-devel/>
List-Post: <mailto:pmg-devel@lists.proxmox.com>
List-Help: <mailto:pmg-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel>,
<mailto:pmg-devel-request@lists.proxmox.com?subject=subscribe>
Cc: pmg-devel@lists.proxmox.com
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pmg-devel-bounces@lists.proxmox.com
Sender: "pmg-devel" <pmg-devel-bounces@lists.proxmox.com>
Thanks big-time for this! Will definitely make life easier when providing
support!
applied it, but added the referenced pve-docs commit to the commit-message
(seems sensible to be able to track this in the future as well)
On Tue, 18 Jun 2024 11:48:18 +0200
Christoph Heiss <c.heiss@proxmox.com> wrote:
> Works the same as for our PVE/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>
> ---
> The PVE equivalent was recently applied [0] - this is essentially the
> same patch, just adapted for pmg-docs.
>
> [0] https://git.proxmox.com/?p=pve-docs.git;a=commit;h=ecab5895a4
>
> asciidoc/pmg-docs.css | 33 +++++++++++++++++++++++++++++++++
> asciidoc/pmg-html.conf | 18 ++++++++++++++----
> 2 files changed, 47 insertions(+), 4 deletions(-)
>
> diff --git a/asciidoc/pmg-docs.css b/asciidoc/pmg-docs.css
> index 45e2b11..47eeb79 100644
> --- a/asciidoc/pmg-docs.css
> +++ b/asciidoc/pmg-docs.css
> @@ -1,6 +1,7 @@
> :root {
> /* pre-defined colors */
> --pdt-grey-950: hsl(0deg, 0%, 95%);
> + --pdt-grey-750: hsl(0deg, 0%, 75%);
> --pdt-grey-400: hsl(0deg, 0%, 40%);
> --pdt-grey-250: hsl(0deg, 0%, 25%);
> --pdt-grey-150: hsl(0deg, 0%, 15%);
> @@ -30,6 +31,38 @@ div.admonitionblock td.icon > img {
> padding: 0.15em;
> }
>
> +/* Support for heading anchor links */
> +h3 {
> + border-bottom: unset;
> +}
> +
> +h3 > span {
> + display: inline-block;
> + border-bottom: 2px solid silver;
> +}
> +
> +a.headerlink {
> + color: var(--pdt-grey-750);
> + padding: 0 4px;
> + text-decoration: none;
> + visibility: hidden;
> +}
> +
> +/* add it as an pseudo-element, so that it does not show up in the ToC */
> +a.headerlink::after {
> + content: '\00b6';
> + text-decoration: none;
> +}
> +
> +h2:hover > a.headerlink,
> +h3:hover > a.headerlink,
> +h4:hover > a.headerlink,
> +h5:hover > a.headerlink,
> +h6:hover > a.headerlink {
> + visibility: visible;
> +}
> +
> +/* Dark mode theme */
> @media screen and (prefers-color-scheme: dark) {
> :root {
> color-scheme: dark;
> diff --git a/asciidoc/pmg-html.conf b/asciidoc/pmg-html.conf
> index 9f694fd..40dae57 100644
> --- a/asciidoc/pmg-html.conf
> +++ b/asciidoc/pmg-html.conf
> @@ -508,7 +508,10 @@ bodydata=<td class="tableblock halign-{colalign=left}">|</td>
>
> [sect1]
> <div class="sect1{style? {style}}{role? {role}}">
> -<h2{id? id="{id}"}>{numbered?{sectnum} }{title}</h2>
> +<h2{id? id="{id}"}>
> +{numbered?{sectnum} }{title}
> +{id? <a class="headerlink" href="#{id}" title="Permalink to this heading"></a>}
> +</h2>
> <div class="sectionbody">
> |
> </div>
> @@ -516,19 +519,26 @@ bodydata=<td class="tableblock halign-{colalign=left}">|</td>
>
> [sect2]
> <div class="sect2{style? {style}}{role? {role}}">
> -<h3{id? id="{id}"}>{numbered?{sectnum} }{title}</h3>
> +<h3{id? id="{id}"}>
> +<span>{numbered?{sectnum} }{title}</span>
> +{id? <a class="headerlink" href="#{id}" title="Permalink to this heading"></a>}
> +</h3>
> |
> </div>
>
> [sect3]
> <div class="sect3{style? {style}}{role? {role}}">
> -<h4{id? id="{id}"}>{numbered?{sectnum} }{title}</h4>
> +<h4{id? id="{id}"}>{numbered?{sectnum} }{title}
> +{id? <a class="headerlink" href="#{id}" title="Permalink to this heading"></a>}
> +</h4>
> |
> </div>
>
> [sect4]
> <div class="sect4{style? {style}}{role? {role}}">
> -<h5{id? id="{id}"}>{title}</h5>
> +<h5{id? id="{id}"}>{title}
> +{id? <a class="headerlink" href="#{id}" title="Permalink to this heading"></a>}
> +</h5>
> |
> </div>
>
_______________________________________________
pmg-devel mailing list
pmg-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel