summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/search/meilisearch.xml
diff options
context:
space:
mode:
Diffstat (limited to 'nixos/modules/services/search/meilisearch.xml')
-rw-r--r--nixos/modules/services/search/meilisearch.xml16
1 files changed, 9 insertions, 7 deletions
diff --git a/nixos/modules/services/search/meilisearch.xml b/nixos/modules/services/search/meilisearch.xml
index c1a73f358c28..8bfd64920b03 100644
--- a/nixos/modules/services/search/meilisearch.xml
+++ b/nixos/modules/services/search/meilisearch.xml
@@ -1,15 +1,17 @@
+<!-- Do not edit this file directly, edit its companion .md instead
+ and regenerate this file using nixos/doc/manual/md-to-db.sh -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-meilisearch">
<title>Meilisearch</title>
<para>
Meilisearch is a lightweight, fast and powerful search engine. Think
elastic search with a much smaller footprint.
</para>
- <section xml:id="quickstart">
+ <section xml:id="module-services-meilisearch-quickstart">
<title>Quickstart</title>
<para>
the minimum to start meilisearch is
</para>
- <programlisting language="bash">
+ <programlisting language="nix">
services.meilisearch.enable = true;
</programlisting>
<para>
@@ -21,20 +23,20 @@ services.meilisearch.enable = true;
<literal>curl -X GET 'http://localhost:7700/health'</literal>
</para>
</section>
- <section xml:id="usage">
+ <section xml:id="module-services-meilisearch-usage">
<title>Usage</title>
<para>
you first need to add documents to an index before you can search
for documents.
</para>
- <section xml:id="add-a-documents-to-the-movies-index">
+ <section xml:id="module-services-meilisearch-quickstart-add">
<title>Add a documents to the <literal>movies</literal>
index</title>
<para>
<literal>curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{&quot;id&quot;: &quot;123&quot;, &quot;title&quot;: &quot;Superman&quot;}, {&quot;id&quot;: 234, &quot;title&quot;: &quot;Batman&quot;}]'</literal>
</para>
</section>
- <section xml:id="search-documents-in-the-movies-index">
+ <section xml:id="module-services-meilisearch-quickstart-search">
<title>Search documents in the <literal>movies</literal>
index</title>
<para>
@@ -44,7 +46,7 @@ services.meilisearch.enable = true;
</para>
</section>
</section>
- <section xml:id="defaults">
+ <section xml:id="module-services-meilisearch-defaults">
<title>Defaults</title>
<itemizedlist>
<listitem>
@@ -70,7 +72,7 @@ services.meilisearch.enable = true;
</listitem>
</itemizedlist>
</section>
- <section xml:id="missing">
+ <section xml:id="module-services-meilisearch-missing">
<title>Missing</title>
<itemizedlist spacing="compact">
<listitem>