nixos: nixos/doc/manual/configuration/wayland.xml to CommonMark

4 files changed, 60 insertions, 34 deletions

diff --git a/nixos/doc/manual/configuration/configuration.xml b/nixos/doc/manual/configuration/configuration.xml
index 4598ae4d139..adc3a88b3d8 100644
--- a/nixos/doc/manual/configuration/configuration.xml
+++ b/nixos/doc/manual/configuration/configuration.xml
@@ -18,7 +18,7 @@
  <xi:include href="../from_md/configuration/user-mgmt.chapter.xml" />
  <xi:include href="file-systems.xml" />
  <xi:include href="../from_md/configuration/x-windows.chapter.xml" />
- <xi:include href="wayland.xml" />
+ <xi:include href="../from_md/configuration/wayland.chapter.xml" />
  <xi:include href="gpu-accel.xml" />
  <xi:include href="xfce.xml" />
  <xi:include href="networking.xml" />
diff --git a/nixos/doc/manual/configuration/wayland.chapter.md b/nixos/doc/manual/configuration/wayland.chapter.md
new file mode 100644
index 00000000000..49c0cab38e5
--- /dev/null
+++ b/nixos/doc/manual/configuration/wayland.chapter.md
@@ -0,0 +1,27 @@
+# Wayland {#sec-wayland}
+
+While X11 (see [](#sec-x11)) is still the primary display technology
+on NixOS, Wayland support is steadily improving. Where X11 separates the
+X Server and the window manager, on Wayland those are combined: a
+Wayland Compositor is like an X11 window manager, but also embeds the
+Wayland \'Server\' functionality. This means it is sufficient to install
+a Wayland Compositor such as sway without separately enabling a Wayland
+server:
+
+```nix
+programs.sway.enable = true;
+```
+
+This installs the sway compositor along with some essential utilities.
+Now you can start sway from the TTY console.
+
+If you are using a wlroots-based compositor, like sway, and want to be
+able to share your screen, you might want to activate this option:
+
+```nix
+xdg.portal.wlr.enable = true;
+```
+
+and configure Pipewire using
+[`services.pipewire.enable`](options.html#opt-services.pipewire.enable)
+and related options.
diff --git a/nixos/doc/manual/configuration/wayland.xml b/nixos/doc/manual/configuration/wayland.xml
deleted file mode 100644
index 2aefda3e22c..00000000000
--- a/nixos/doc/manual/configuration/wayland.xml
+++ /dev/null
@@ -1,33 +0,0 @@
-<chapter xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         version="5.0"
-         xml:id="sec-wayland">
- <title>Wayland</title>
-
- <para>
-  While X11 (see <xref linkend="sec-x11"/>) is still the primary display
-  technology on NixOS, Wayland support is steadily improving.
-  Where X11 separates the X Server and the window manager, on Wayland those
-  are combined: a Wayland Compositor is like an X11 window manager, but also
-  embeds the Wayland 'Server' functionality. This means it is sufficient to
-  install a Wayland Compositor such as <package>sway</package> without
-  separately enabling a Wayland server:
-<programlisting>
-<xref linkend="opt-programs.sway.enable"/> = true;
-</programlisting>
-  This installs the <package>sway</package> compositor along with some
-  essential utilities. Now you can start <package>sway</package> from the TTY
-  console.
- </para>
-
- <para>
-  If you are using a wlroots-based compositor, like sway, and want to be able to
-  share your screen, you might want to activate this option:
-<programlisting>
-<xref linkend="opt-xdg.portal.wlr.enable"/> = true;
-</programlisting>
-  and configure Pipewire using <xref linkend="opt-services.pipewire.enable"/>
-  and related options.
- </para>
-</chapter>
diff --git a/nixos/doc/manual/from_md/configuration/wayland.chapter.xml b/nixos/doc/manual/from_md/configuration/wayland.chapter.xml
new file mode 100644
index 00000000000..166925f67d2
--- /dev/null
+++ b/nixos/doc/manual/from_md/configuration/wayland.chapter.xml
@@ -0,0 +1,32 @@
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-wayland">
+  <title>Wayland</title>
+  <para>
+    While X11 (see <xref linkend="sec-x11" />) is still the primary
+    display technology on NixOS, Wayland support is steadily improving.
+    Where X11 separates the X Server and the window manager, on Wayland
+    those are combined: a Wayland Compositor is like an X11 window
+    manager, but also embeds the Wayland 'Server' functionality. This
+    means it is sufficient to install a Wayland Compositor such as sway
+    without separately enabling a Wayland server:
+  </para>
+  <programlisting language="bash">
+programs.sway.enable = true;
+</programlisting>
+  <para>
+    This installs the sway compositor along with some essential
+    utilities. Now you can start sway from the TTY console.
+  </para>
+  <para>
+    If you are using a wlroots-based compositor, like sway, and want to
+    be able to share your screen, you might want to activate this
+    option:
+  </para>
+  <programlisting language="bash">
+xdg.portal.wlr.enable = true;
+</programlisting>
+  <para>
+    and configure Pipewire using
+    <link xlink:href="options.html#opt-services.pipewire.enable"><literal>services.pipewire.enable</literal></link>
+    and related options.
+  </para>
+</chapter>