@diplodoc/cli 5.46.1 → 5.47.0

package/tests/mocks/includes/input/includes/commented-include.md

@@ -0,0 +1,5 @@
+This is a commented include.
+
+<!-- {% include [test](test.md) %} -->
+
+[Link to index](../index.md)

package/tests/mocks/includes/input/includes/deep-include.md

@@ -0,0 +1,13 @@
+# Deep nested include [→ index](../index.md) {#deep-nested-include}
+
+[Link to index](../index.md)
+
+[Link to level1 page1](../level1/page1.md)
+
+[Link to level2 page2](../level1/level2/page2.md)
+
+This is a deep nested include.
+
+{% include [user](user.md) %}
+
+![img 3](../_assets/{{img_3}})

package/tests/mocks/includes/input/includes/fragments.md

@@ -0,0 +1,23 @@
+# Fragments for include
+
+## Section 1 {#section1}
+
+This is content of section 1.
+
+## Section 2 {#section2}
+
+This is content of section 2.
+
+### Subsection 2.1 {#subsection21}
+
+This is content of subsection 2.1.
+
+## Section 3 {#section3}
+
+This is content of section 3.
+
+Some paragraph with anchor {#p1}
+
+Some paragraph without anchor
+
+Some paragraph with anchor {#p2}

package/tests/mocks/includes/input/includes/nested-include.md

@@ -0,0 +1,5 @@
+# Nested include [→ index](../index.md) {#nested-include}
+
+This is a nested include.
+
+{% include [level1-include](../level1/includes/level1-include.md) %}

package/tests/mocks/includes/input/includes/no-title-include.md

@@ -0,0 +1,19 @@
+# Include without title [→ index](../index.md) {#include-without-title}
+
+[Link to index](../index.md)
+
+This is a test for include without title.
+
+## Include without title from the same directory
+
+{% include notitle [user](user.md) %}
+
+## Include without title with anchor
+
+{% include notitle [fragment](fragments.md#section1) %}
+
+## Include without title with paragraph anchor
+
+{% include notitle [fragment](fragments.md#p1) %}
+
+[Link to index](../index.md)

package/tests/mocks/includes/input/includes/root-include.md

@@ -0,0 +1,11 @@
+This is an include from the root level.
+
+[Link to level1](../level1/page1.md)
+
+[Link to level2](../level1/level2/page2.md)
+
+[Link to index](../index.md)
+
+## Include with anchor [→ level1](../level1/page1.md) {#include-with-anchor}
+
+{% include [fragment](fragments.md#section2) %}

package/tests/mocks/includes/input/includes/user.md

@@ -0,0 +1,5 @@
+# User include [→ index](../index.md) {#user-include}
+
+[Link to index](../index.md)
+
+This is a user include with variable substitution: {{user}}

package/tests/mocks/includes/input/index.md

@@ -0,0 +1,69 @@
+# Test Includes
+
+This is a test page for various include scenarios.
+
+## Include from root level
+
+{% include [root-include](includes/root-include.md) %}
+
+## Include from level1
+
+{% include [level1-include](level1/includes/level1-include.md) %}
+
+## Include from level2
+
+{% include [level2-include](level1/level2/includes/level2-include.md) %}
+
+## Include with missing file
+
+<!-- {% include [missing](includes/missing.md) %} -->
+
+## Include file that is in toc
+
+[Link to toc-include](toc-include.md)
+
+{% include [toc-include](toc-include.md) %}
+
+## Links to different levels
+
+[Link to level1](level1/page1.md)
+
+[Link to level2](level1/level2/page2.md)
+
+## Include with anchor
+
+{% include [fragment](includes/fragments.md#section1) %}
+
+## Include with multiple anchors
+
+{% include [fragment](includes/fragments.md#section2) %}
+
+## Include with paragraph anchor
+
+{% include [fragment](includes/fragments.md#p1) %}
+
+## Nested includes
+
+{% include [nested](includes/nested-include.md) %}
+
+## Deep nested includes
+
+{% include [deep](includes/deep-include.md) %}
+
+## Commented includes
+
+<!-- {% include [commented](includes/commented-include.md) %} -->
+
+## Include with variable substitution
+
+{% include [user](includes/user.md) %}
+## Include without title
+
+{% include [no-title-include](includes/no-title-include.md) %}
+
+## Include with anchor {#anchor}
+
+{% include notitle [anchor](#anchor) %}
+{% include [anchor](#anchor) %}
+
+{% include [no-title-include](includes/no-title-include.md#anchor) %}

package/tests/mocks/includes/input/level1/includes/level1-include.md

@@ -0,0 +1,11 @@
+This is an include from level 1.
+
+[Link to page1](../page1.md)
+
+[Link to index](../../index.md)
+
+[Link to level2](../level2/page2.md)
+
+## Include with anchor [→ root](../../index.md) {#include-with-anchor}
+
+{% include [fragment](../../includes/fragments.md#subsection21) %}

package/tests/mocks/includes/input/level1/level2/includes/level2-include.md

@@ -0,0 +1,11 @@
+This is an include from level 2.
+
+[Link to page2](../page2.md)
+
+[Link to page1](../../page1.md)
+
+[Link to index](../../../index.md)
+
+## Include with anchor [→ level1](../../page1.md) {#include-with-anchor}
+
+{% include [fragment](../../../includes/fragments.md#section3) %}

package/tests/mocks/includes/input/level1/level2/page2.md

@@ -0,0 +1,29 @@
+# Page 2
+
+This is page 2 at level 2.
+
+## Include from level2
+
+{% include [level2-include](includes/level2-include.md) %}
+
+## Include from level1
+
+{% include [level1-include](../includes/level1-include.md) %}
+
+## Include from root
+
+{% include [root-include](../../includes/root-include.md) %}
+
+## Links to different levels
+
+[Link to index](../../index.md)
+
+[Link to page1](../page1.md)
+
+## Nested include
+
+{% include [nested-include](../../includes/nested-include.md) %}
+
+## Include with anchor
+
+{% include [fragment](../../includes/fragments.md#section3) %}

package/tests/mocks/includes/input/level1/page1.md

@@ -0,0 +1,29 @@
+# Page 1
+
+This is page 1 at level 1.
+
+## Include from level1
+
+{% include [level1-include](includes/level1-include.md) %}
+
+## Include from root
+
+{% include [root-include](../includes/root-include.md) %}
+
+## Include from level2
+
+{% include [level2-include](level2/includes/level2-include.md) %}
+
+## Links to different levels
+
+[Link to index](../index.md)
+
+[Link to level2](level2/page2.md)
+
+## Nested include
+
+{% include [nested-include](../includes/nested-include.md) %}
+
+## Include with anchor
+
+{% include [fragment](../includes/fragments.md#subsection21) %}

package/tests/mocks/includes/input/presets.yaml

@@ -0,0 +1,3 @@
+default:
+  user: Alice
+  img_3: 4.png

package/tests/mocks/includes/input/toc-include.md

@@ -0,0 +1,13 @@
+# Toc Include
+
+This file is included in the toc.
+
+[Link to index](index.md)
+
+[Link to page1](level1/page1.md)
+
+[Link to page2](level1/level2/page2.md)
+
+## Include with anchor
+
+{% include [fragment](includes/fragments.md#section1) %}

package/tests/mocks/includes/input/toc.yaml

@@ -0,0 +1,13 @@
+items:
+  - name: Test Includes
+    href: index.md
+  - name: Toc Include
+    href: toc-include.md
+  - name: Level 1
+    items:
+      - name: Page 1
+        href: level1/page1.md
+      - name: Level 2
+        items:
+          - name: Page 2
+            href: level1/level2/page2.md

package/tests/mocks/includes-conditions/input/includes/first.md

@@ -0,0 +1,5 @@
+{% note info %}
+
+This is the first include.
+
+{% endnote %}

package/tests/mocks/includes-conditions/input/includes/second.md

@@ -0,0 +1,5 @@
+{% if condition_var == true %}
+
+This is the second include, which should be hidden.
+
+{% endif %}

package/tests/mocks/includes-conditions/input/includes/third.md

@@ -0,0 +1 @@
+This is the third include.

package/tests/mocks/includes-conditions/input/index.md

@@ -0,0 +1,7 @@
+# Test Includes Conditions
+
+{% include [first](includes/first.md) %}
+
+{% include [second](includes/second.md) %}
+
+{% include [third](includes/third.md) %}

package/tests/mocks/includes-conditions/input/presets.yaml

@@ -0,0 +1,2 @@
+default:
+  condition_var: false

package/tests/mocks/includes-conditions/input/toc.yaml

@@ -0,0 +1,3 @@
+items:
+  - name: Test Includes Conditions
+    href: index.md

package/tests/mocks/includes-missing/input/index.md

@@ -0,0 +1,7 @@
+# Test Includes with Missing File
+
+This is a test page for include with missing file scenario.
+
+## Include with missing file
+
+{% include [missing](includes/missing.md) %}

package/tests/mocks/includes-missing/input/toc.yaml

@@ -0,0 +1,3 @@
+items:
+  - name: Test Includes with Missing File
+    href: index.md

package/tests/mocks/llms/input/.yfm

@@ -0,0 +1 @@
+allowHtml: true

package/tests/mocks/llms/input/_includes/requirements.md

@@ -0,0 +1,4 @@
+## Requirements
+
+- Node.js 18+
+- 2 GB RAM

package/tests/mocks/llms/input/api.md

@@ -0,0 +1,9 @@
+---
+description: Full reference of the public HTTP endpoints.
+---
+
+# API Reference
+
+## GET /things
+
+Returns the list of things.

package/tests/mocks/llms/input/beta.md

@@ -0,0 +1,4 @@
+# Beta Feature
+
+This page is gated behind `when: showBeta` and must NOT appear in the llms
+artifacts for the default (showBeta = false) version.

package/tests/mocks/llms/input/index.md

@@ -0,0 +1,8 @@
+---
+title: Overview
+description: What this product is and how to get started.
+---
+
+# Overview
+
+Welcome to **My Product** — the documentation home page.

package/tests/mocks/llms/input/presets.yaml

@@ -0,0 +1,2 @@
+default:
+  showBeta: false

package/tests/mocks/llms/input/start.md

@@ -0,0 +1,9 @@
+---
+description: Install the product and build your first project.
+---
+
+# Getting Started
+
+Run the installer and create your first project.
+
+{% include [Requirements](_includes/requirements.md) %}

package/tests/mocks/llms/input/toc.yaml

@@ -0,0 +1,11 @@
+title: My Product
+href: index.md
+
+items:
+  - name: Getting Started
+    href: start.md
+  - name: API Reference
+    href: api.md
+  - name: Beta Feature
+    href: beta.md
+    when: showBeta

package/tests/mocks/load-custom-resources/md2html-with-resources/input/.yfm

@@ -0,0 +1,5 @@
+resources:
+  style:
+    - _assets/style/test.css
+  script:
+    - _assets/script/test1.js

package/tests/mocks/load-custom-resources/md2html-with-resources/input/_assets/style/test.css

@@ -0,0 +1,13 @@
+.Header {
+    background-color: darkkhaki;
+}
+
+h1 {
+    /*font-family: 'Qwitcher Grypen', cursive;*/
+    font-family: 'QwitcherGrypen-Regular';
+}
+
+@font-face {
+    font-family: 'QwitcherGrypen-Regular';
+    src: url('https://yfm-test-doc123.martyanov-av.ui.yandex.net/docs-assets/yfm-test-doc123/test39/ru/_assets/fonts/QwitcherGrypen-Regular.ttf');
+}

package/tests/mocks/load-custom-resources/md2html-with-resources/input/index.yaml

@@ -0,0 +1,9 @@
+title: Documentation
+description: ""
+meta:
+  title: Documentation
+  noIndex: true
+links:
+  - title: Getting started with Documentation
+    description: This guide will show you the basics of working with Documentation
+    href: page.md

package/tests/mocks/load-custom-resources/md2html-with-resources/input/page.md

@@ -0,0 +1,14 @@
+---
+title: Page Title
+description: Some test description
+
+interface:
+  toc: false
+  favicon-src: /favicon.ico
+
+metadata:
+  - name: yfm
+    content: builder in page
+---
+
+Lorem

package/tests/mocks/load-custom-resources/md2html-with-resources/input/project/config.md

@@ -0,0 +1 @@
+Lorem

package/tests/mocks/load-custom-resources/md2html-with-resources/input/toc.yaml

@@ -0,0 +1,7 @@
+title: Documentation
+href: index.yaml
+items:
+  - name: Documentation
+    href: page.md
+  - name: Config
+    href: project/config.md

package/tests/mocks/load-custom-resources/md2md-with-resources/input/.yfm

@@ -0,0 +1,5 @@
+resources:
+  style:
+    - _assets/style/test.css
+  script:
+    - _assets/script/test1.js

package/tests/mocks/load-custom-resources/md2md-with-resources/input/_assets/style/test.css

@@ -0,0 +1,13 @@
+.Header {
+    background-color: darkkhaki;
+}
+
+h1 {
+    /*font-family: 'Qwitcher Grypen', cursive;*/
+    font-family: 'QwitcherGrypen-Regular';
+}
+
+@font-face {
+    font-family: 'QwitcherGrypen-Regular';
+    src: url('https://yfm-test-doc123.martyanov-av.ui.yandex.net/docs-assets/yfm-test-doc123/test39/ru/_assets/fonts/QwitcherGrypen-Regular.ttf');
+}

package/tests/mocks/load-custom-resources/md2md-with-resources/input/index.yaml

@@ -0,0 +1,9 @@
+title: Documentation
+description: ""
+meta:
+  title: Documentation
+  noIndex: true
+links:
+  - title: Getting started with Documentation
+    description: This guide will show you the basics of working with Documentation
+    href: page.md

package/tests/mocks/load-custom-resources/md2md-with-resources/input/page.md

@@ -0,0 +1,14 @@
+---
+title: Page Title
+description: Some test description
+
+interface:
+  toc: false
+  favicon-src: /favicon.ico
+
+metadata:
+  - name: yfm
+    content: builder in page
+---
+
+Lorem

package/tests/mocks/load-custom-resources/md2md-with-resources/input/project/config.md

@@ -0,0 +1 @@
+Lorem

package/tests/mocks/load-custom-resources/md2md-with-resources/input/toc.yaml

@@ -0,0 +1,7 @@
+title: Documentation
+href: index.yaml
+items:
+  - name: Documentation
+    href: page.md
+  - name: Config
+    href: project/config.md

package/tests/mocks/load-custom-resources/single-page-with-resources/input/.yfm

@@ -0,0 +1,5 @@
+resources:
+  style:
+    - _assets/style/test.css
+  script:
+    - _assets/script/test1.js

package/tests/mocks/load-custom-resources/single-page-with-resources/input/_assets/style/test.css

@@ -0,0 +1,13 @@
+.Header {
+    background-color: darkkhaki;
+}
+
+h1 {
+    /*font-family: 'Qwitcher Grypen', cursive;*/
+    font-family: 'QwitcherGrypen-Regular';
+}
+
+@font-face {
+    font-family: 'QwitcherGrypen-Regular';
+    src: url('https://yfm-test-doc123.martyanov-av.ui.yandex.net/docs-assets/yfm-test-doc123/test39/ru/_assets/fonts/QwitcherGrypen-Regular.ttf');
+}

package/tests/mocks/load-custom-resources/single-page-with-resources/input/index.yaml

@@ -0,0 +1,9 @@
+title: Documentation
+description: ""
+meta:
+  title: Documentation
+  noIndex: true
+links:
+  - title: Getting started with Documentation
+    description: This guide will show you the basics of working with Documentation
+    href: page.md

package/tests/mocks/load-custom-resources/single-page-with-resources/input/page.md

@@ -0,0 +1,14 @@
+---
+title: Page Title
+description: Some test description
+
+interface:
+  toc: false
+  favicon-src: /favicon.ico
+
+metadata:
+  - name: yfm
+    content: builder in page
+---
+
+Lorem

package/tests/mocks/load-custom-resources/single-page-with-resources/input/project/config.md

@@ -0,0 +1 @@
+Lorem

package/tests/mocks/load-custom-resources/single-page-with-resources/input/toc.yaml

@@ -0,0 +1,7 @@
+title: Documentation
+href: index.yaml
+items:
+  - name: Documentation
+    href: page.md
+  - name: Config
+    href: project/config.md

package/tests/mocks/markdown-options/example-1/input/.yfm

@@ -0,0 +1,5 @@
+breaks: false
+linkify: true
+linkifyTlds:
+  - myext
+  - custom

package/tests/mocks/markdown-options/example-1/input/breaks.md

@@ -0,0 +1,5 @@
+# Breaks test
+
+First sentence
+Second sentence
+Third sentence

package/tests/mocks/markdown-options/example-1/input/linkify-tlds.md

@@ -0,0 +1,7 @@
+# Linkify TLDs test
+
+Visit example.myext for custom TLD.
+
+Standard example.com link.
+
+Unknown example.faketld should not be linked.

package/tests/mocks/markdown-options/example-1/input/linkify.md

@@ -0,0 +1,3 @@
+# Linkify test
+
+Visit https://example.com for more info.

package/tests/mocks/markdown-options/example-1/input/toc.yaml

@@ -0,0 +1,7 @@
+items:
+  - name: Breaks
+    href: ./breaks.md
+  - name: Linkify
+    href: ./linkify.md
+  - name: Linkify TLDs
+    href: ./linkify-tlds.md

package/tests/mocks/markdown-options/example-2/input/.yfm

@@ -0,0 +1,3 @@
+breaks: true
+linkify: false
+

package/tests/mocks/markdown-options/example-2/input/breaks.md

@@ -0,0 +1,5 @@
+# Breaks test
+
+First sentence
+Second sentence
+Third sentence

package/tests/mocks/markdown-options/example-2/input/linkify-tlds.md

@@ -0,0 +1,7 @@
+# Linkify TLDs test
+
+Visit example.myext for custom TLD.
+
+Standard example.com link.
+
+Unknown example.faketld should not be linked.

package/tests/mocks/markdown-options/example-2/input/linkify.md

@@ -0,0 +1,3 @@
+# Linkify test
+
+Visit https://example.com for more info.

package/tests/mocks/markdown-options/example-2/input/toc.yaml

@@ -0,0 +1,7 @@
+items:
+  - name: Breaks
+    href: ./breaks.md
+  - name: Linkify
+    href: ./linkify.md
+  - name: Linkify TLDs
+    href: ./linkify-tlds.md