mirror of
https://github.com/nix-community/nixvim.git
synced 2025-06-21 00:25:42 +02:00
docs: patch nixos-render-docs to output GFM alerts
This does not add support for _using_ GFM syntax alerts, the nixpkgs syntax must still be used in option descriptions for now.
This commit is contained in:
parent
79010edc14
commit
d0c0821245
2 changed files with 63 additions and 3 deletions
48
docs/0001-Output-GFM-admonition.patch
Normal file
48
docs/0001-Output-GFM-admonition.patch
Normal file
|
@ -0,0 +1,48 @@
|
|||
From 4545eca44e0865f4ccab518d8e1591f714cb333c Mon Sep 17 00:00:00 2001
|
||||
From: Matt Sturgeon <matt@sturgeon.me.uk>
|
||||
Date: Tue, 10 Sep 2024 15:37:56 +0100
|
||||
Subject: [PATCH] Output GFM admonition
|
||||
|
||||
---
|
||||
nixos_render_docs/commonmark.py | 5 +++--
|
||||
tests/test_commonmark.py | 8 +++++---
|
||||
2 files changed, 8 insertions(+), 5 deletions(-)
|
||||
|
||||
diff --git a/nixos_render_docs/commonmark.py b/nixos_render_docs/commonmark.py
|
||||
index 6287b60f0a51..b39bff625314 100644
|
||||
--- a/nixos_render_docs/commonmark.py
|
||||
+++ b/nixos_render_docs/commonmark.py
|
||||
@@ -45,8 +45,9 @@ class CommonMarkRenderer(Renderer):
|
||||
|
||||
def _admonition_open(self, kind: str) -> str:
|
||||
pbreak = self._maybe_parbreak()
|
||||
- self._enter_block("")
|
||||
- return f"{pbreak}**{kind}:** "
|
||||
+ lbreak = self._break()
|
||||
+ self._enter_block("> ")
|
||||
+ return f"{pbreak}> [!{kind}]{lbreak}> "
|
||||
def _admonition_close(self) -> str:
|
||||
self._leave_block()
|
||||
return ""
|
||||
diff --git a/tests/test_commonmark.py b/tests/test_commonmark.py
|
||||
index 4ff0bc3095c3..e151325338ca 100644
|
||||
--- a/tests/test_commonmark.py
|
||||
+++ b/tests/test_commonmark.py
|
||||
@@ -27,9 +27,11 @@ def test_indented_fence() -> None:
|
||||
def test_full() -> None:
|
||||
c = Converter({ 'man(1)': 'http://example.org' })
|
||||
assert c._render(sample1) == """\
|
||||
-**Warning:** foo
|
||||
-
|
||||
-**Note:** nested
|
||||
+> [!Warning]
|
||||
+> foo
|
||||
+>
|
||||
+> > [!Note]
|
||||
+> > nested
|
||||
|
||||
[
|
||||
multiline
|
||||
--
|
||||
2.46.0
|
||||
|
|
@ -31,9 +31,21 @@ let
|
|||
}
|
||||
);
|
||||
|
||||
pkgsDoc = pkgs // {
|
||||
inherit lib;
|
||||
};
|
||||
# Extended nixpkgs instance, with patches to nixos-render-docs
|
||||
pkgsDoc = pkgs.extend (
|
||||
final: prev: {
|
||||
inherit lib;
|
||||
|
||||
nixos-render-docs = prev.nixos-render-docs.overrideAttrs (old: {
|
||||
patches = old.patches or [ ] ++ [
|
||||
# Adds support for GFM-style admonitions in rendered commonmark
|
||||
./0001-Output-GFM-admonition.patch
|
||||
# TODO:add support for _parsing_ GFM admonitions too
|
||||
# https://github.com/nix-community/nixvim/issues/2217
|
||||
];
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
helpers = import ../lib/helpers.nix {
|
||||
inherit lib;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue