@diplodoc/cli 5.46.1 → 5.47.0

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

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

package/tests/mocks/regression/input/includes/styles.md

@@ -0,0 +1,8 @@
+<style>
+
+.yfm .border-yes {
+    border: 1px solid #ccc;
+    border-radius: 10px;
+}
+
+</style>

package/tests/mocks/regression/input/includes/test.md

@@ -0,0 +1 @@
+Test

package/tests/mocks/regression/input/includes/tools.md

@@ -0,0 +1 @@
+Tool: {{tools}}

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

@@ -0,0 +1 @@
+{{user}}

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

@@ -0,0 +1,33 @@
+Text
+
+{% include [user](includes/user.md) %}
+
+{% include [test](includes/test.md) %}
+
+{% include [test](includes/fragments.md#f1) %}
+
+{% include [test](includes/fragments.md#p1) %}
+
+<!--{% include [For includes/deep.md](includes/deep.md) %}-->
+{% include [For includes/deep.md](includes/deep.md) %}
+
+^[?](*term)^
+
+[[?](*term)](http://ya.ru)
+
+[Term 1](*term1) [Term 2](*term2)
+
+Link after include
+[{#T}](./1.md#subtitle)
+
+Autotitle include
+<!-- [{#T}](includes/fragments.md#f3) -->
+
+Link after include
+
+## Mermaid
+{% include [test](mermaid.md) %}
+
+[*term]: Test terms
+[*term1]: {% include [test](includes/fragments.md#f3) %}
+[*term2]: {% include [test](includes/fragments.md#f3) %}

package/tests/mocks/regression/input/index.yaml

@@ -0,0 +1,9 @@
+description:
+  - text:
+  - >-
+    Some text
+links:
+  - name: Link 1
+    href: ./1.md
+  - name: Link 2
+    href: ./1

package/tests/mocks/regression/input/latex.md

@@ -0,0 +1,3 @@
+# Latex usage
+
+$\sqrt{3x-1}+(1+x)^2$

package/tests/mocks/regression/input/merge/merge.md

@@ -0,0 +1,5 @@
+# Should use merged item
+
+[merged](./merged.md)
+
+{% include [tools](../includes/tools.md) %}

package/tests/mocks/regression/input/merge/presets.yaml

@@ -0,0 +1,3 @@
+default:
+  product: merge
+  tools: Hammer and Laser

package/tests/mocks/regression/input/merge/toc.yaml

@@ -0,0 +1,6 @@
+items:
+  - name: Use merged
+    href: ./merge.md
+  - name: Multitoc item
+    href: ../1.md
+  - include: {path: ../merge-source/toc-m.yaml, mode: merge}

package/tests/mocks/regression/input/merge-source/merged.md

@@ -0,0 +1,3 @@
+# Merged item
+
+Should be linked in toc.yaml

package/tests/mocks/regression/input/merge-source/toc-m.yaml

@@ -0,0 +1,4 @@
+items:
+  - name: Merged item
+    href: merged.md
+    when: product == 'merge'

package/tests/mocks/regression/input/mermaid.md

@@ -0,0 +1,13 @@
+# Mermaid usage
+
+```mermaid
+
+  sequenceDiagram
+        rect rgba(251, 243, 232, 0.2)
+            Alice ->> Bob:
+        end
+  ```
+
+## Mermaid info {#info}
+
+Some mermaid info

package/tests/mocks/regression/input/openapi-spec.yaml

@@ -0,0 +1,111 @@
+openapi: 3.0.1
+info:
+  title: OpenAPI definition
+  version: v0
+servers:
+  - url: http://localhost:8080
+    description: Generated server url
+paths:
+  /test:
+    get:
+      tags:
+        - test-controller
+      summary: Simple get operation. тест новой верстки 3
+      description: Defines a simple get operation with no inputs and a complex
+      operationId: getWithPayloadResponse
+      responses:
+        "200":
+          description: 200!!!!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RecurceTop'
+  /hidden-test:
+    get:
+      tags:
+        - test-controller
+      summary: Test x-hidden attribute
+      description: Test various x-hidden scenarios
+      operationId: getHiddenTest
+      responses:
+        "200":
+          description: Response with hidden fields
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HiddenTestResponse'
+components:
+  schemas:
+    RecurceTop:
+      type: object
+      properties:
+        A:
+          type: string
+    #          $ref: '#/components/schemas/RecurceMiddle'
+    RecurceMiddle:
+      type: object
+      properties:
+        B:
+          type: array
+          items:
+            $ref: '#/components/schemas/RecurceTop'
+    
+    # Hidden field schemas for testing
+    HiddenField:
+      type: string
+      description: This field should be hidden
+      x-hidden: true
+    
+    HiddenObject:
+      type: object
+      description: This entire object should be hidden
+      x-hidden: true
+      properties:
+        secret:
+          type: string
+    
+    HiddenTestResponse:
+      type: object
+      description: Response object with various hidden field scenarios
+      properties:
+        visibleField:
+          type: string
+          description: This field should be visible
+        directlyHiddenField:
+          type: string
+          description: This field should be hidden (direct x-hidden)
+          x-hidden: true
+        refToHiddenField:
+          $ref: '#/components/schemas/HiddenField'
+        refToHiddenObject:
+          $ref: '#/components/schemas/HiddenObject'
+        nestedObject:
+          type: object
+          description: Object with hidden properties
+          properties:
+            visibleNested:
+              type: string
+            hiddenNested:
+              type: string
+              x-hidden: true
+            refToHiddenInNested:
+              $ref: '#/components/schemas/HiddenField'
+        arrayWithHiddenItems:
+          type: array
+          description: Array with hidden item schema
+          items:
+            $ref: '#/components/schemas/HiddenField'
+        mixedVisibility:
+          type: object
+          properties:
+            field1:
+              type: string
+            field2:
+              $ref: '#/components/schemas/HiddenField'
+            field3:
+              type: string
+            field4:
+              type: string
+              x-hidden: true
+            field5:
+              type: string

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

@@ -0,0 +1,12 @@
+default:
+  default-var: default-var-value
+  not-var: not-var-value
+  product: root
+  user: Bob
+  img_3: 3.png
+  # Test for race condition fix - __system should appear in output metadata
+  __system:
+    testVar: test-value
+
+internal:
+  default-var: default-var-internal-value

package/tests/mocks/regression/input/redirects.yaml

@@ -0,0 +1,6 @@
+files:
+  - from: 'c.md'
+    to: 'd.md'
+common:
+  - from: './a.md'
+    to: './b.md'

package/tests/mocks/regression/input/sub/folder/item-1.md

@@ -0,0 +1,5 @@
+# Item 1
+
+Item 1 text
+
+[{#T}](../../images.md)

package/tests/mocks/regression/input/sub/toc.yaml

@@ -0,0 +1,5 @@
+items:
+  name: Named include (items is Object here - this is not an error)
+  items:
+    - name: Item 1
+      href: folder/item-1.md

package/tests/mocks/regression/input/toc-i.yaml

@@ -0,0 +1,3 @@
+items:
+  - name: Included Item
+    href: ./included-item.md

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

@@ -0,0 +1,43 @@
+items:
+  - name: Verbose root (index.yaml) will be transformed to index.html
+    href: index.yaml
+  - name: Root will be transformed to index.html
+    href: /
+  - name: Md item with not_var syntax
+    href: ./1.md
+  - name: Md item named without extension
+    href: ./1
+  - name: Item with empty href
+    href:
+  - name: Multitoc item
+    href: ./merge/merged.md
+  - name: Fragments
+    href: ./includes/fragments.md
+  - include: {path: toc-i.yaml}
+  - include: {path: sub/toc.yaml, mode: link}
+  - href: ./mermaid
+  - name: '{#T}'
+    href: ./latex
+  - name: Images
+    href: ./images
+  - name: Autotitle
+    href: ./autotitle
+  - name: includes
+    href: ./includes
+  # Test for race condition: entry-as-include.md is both an entry and included by includer-of-entry.md
+  - name: Entry as include
+    href: ./entry-as-include.md
+  - name: Includer of entry
+    href: ./includer-of-entry.md
+  - name: generic
+    include:
+      path: generic
+      includers:
+        - name: generic
+  - name: openapi
+    include:
+      path: openapi
+      includers:
+        - name: openapi
+          input: openapi-spec.yaml
+

package/tests/mocks/restricted-access/test1/input/plugins/index4.md

@@ -0,0 +1,4 @@
+---
+restricted-access:
+  - - customInFile
+---

package/tests/mocks/restricted-access/test1/input/toc.yaml

@@ -0,0 +1,28 @@
+title: Yandex Flavored Markdown
+items:
+  - name: Yandex Flavored Markdown
+    href: index.md
+    restricted-access: admin
+  - name: Plugins
+    items:
+      - name: Overview
+        href: plugins/index.md
+        restricted-access:
+          - admin
+  - name: Plugins 2
+    restricted-access: admin
+    items:
+      - name: Overview 2
+        href: plugins/index2.md
+        restricted-access:
+          - admin
+          - user
+      - name: Overview 3
+        href: plugins/index3.md
+        restricted-access:
+          - admin
+      - name: Overview 4
+        href: plugins/index4.md
+        restricted-access:
+          - admin
+

package/tests/mocks/restricted-access/test2/input/toc.yaml

@@ -0,0 +1,21 @@
+title: Yandex Flavored Markdown
+items:
+  - name: Plugins
+    restricted-access: 
+     - admin
+     - manager
+    items:
+      - name: Overview
+        href: plugins/index.md
+        restricted-access:
+          - userA
+          - userB
+  - name: Organizing a YFM project
+    items:
+      - name: Overview
+        href: project/index.md
+        restricted-access:
+          - userA
+          - userB
+
+

package/tests/mocks/restricted-access/test3/input/a1.md

@@ -0,0 +1 @@
+This is the /a1.md file content.

package/tests/mocks/restricted-access/test3/input/folder1/a1.md

@@ -0,0 +1 @@
+This is the /folder1/a1.md file content.

package/tests/mocks/restricted-access/test3/input/folder1/folder2/a1.md

@@ -0,0 +1 @@
+This is the /folder1/folder1/a1.md file content.

package/tests/mocks/restricted-access/test3/input/folder1/folder2/toc.yaml

@@ -0,0 +1,8 @@
+items:
+  - name: A1
+    href: a1.md
+    restricted-access:
+      - userAtoc3
+      - userBtoc3
+
+

package/tests/mocks/restricted-access/test3/input/folder1/toc.yaml

@@ -0,0 +1,10 @@
+items:
+  - name: A1
+    href: a1.md
+    restricted-access:
+      - userAtoc2
+      - userBtoc2
+  - name: folder1
+    include:
+      mode: link
+      path: folder2/toc.yaml

package/tests/mocks/restricted-access/test3/input/toc.yaml

@@ -0,0 +1,16 @@
+items:
+  - name: A1
+    href: a1.md
+  - name: folder1
+    restricted-access:
+      - userA
+      - userB
+    include:
+      mode: link
+      path: folder1/toc.yaml
+      
+
+
+
+
+

package/tests/mocks/rtl/multidirectional-languages/input/.yfm

@@ -0,0 +1 @@
+langs: ['ar', 'en']

package/tests/mocks/rtl/multidirectional-languages/input/ar/index.yaml

@@ -0,0 +1,4 @@
+title: Documentation
+links:
+  - title: Documentation
+    href: page.md

package/tests/mocks/rtl/multidirectional-languages/input/ar/page.md

@@ -0,0 +1 @@
+توثيق

package/tests/mocks/rtl/multidirectional-languages/input/ar/toc.yaml

@@ -0,0 +1,5 @@
+title: Documentation
+href: index.yaml
+items:
+  - name: Documentation
+    href: page.md

package/tests/mocks/rtl/multidirectional-languages/input/en/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/rtl/multidirectional-languages/input/en/page.md

@@ -0,0 +1,7 @@
+---
+metadata:
+  - name: yfm
+    content: builder
+---
+
+Lorem

package/tests/mocks/rtl/multidirectional-languages/input/en/toc.yaml

@@ -0,0 +1,5 @@
+title: Documentation
+href: index.yaml
+items:
+  - name: Documentation
+    href: page.md

package/tests/mocks/rtl/rtl-language/input/.yfm

@@ -0,0 +1 @@
+langs: ['he']

package/tests/mocks/rtl/rtl-language/input/index.yaml

@@ -0,0 +1,4 @@
+title: Documentation
+links:
+  - title: Documentation
+    href: page.md

package/tests/mocks/rtl/rtl-language/input/page.md

@@ -0,0 +1 @@
+תיעוד

package/tests/mocks/rtl/rtl-language/input/toc.yaml

@@ -0,0 +1,5 @@
+title: Documentation
+href: index.yaml
+items:
+  - name: Documentation
+    href: page.md

package/tests/mocks/search/input/.yfm

@@ -0,0 +1,12 @@
+allowHtml: true
+langs: ['en','ru']
+
+interface:
+  toc-header: false
+  favicon-src: https://storage.yandexcloud.net/diplodoc-www-assets/favicon/favicon.ico
+
+search:
+  provider: local
+  tolerance: 2
+  confidense: phrased
+  

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

@@ -0,0 +1,3 @@
+# Header
+
+Content

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

@@ -0,0 +1 @@
+href: index.md

package/tests/mocks/single-page/input/ru/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/single-page/input/ru/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/single-page/input/ru/project/config.md

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

package/tests/mocks/single-page/input/ru/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/skip-html-extension/monolingual/input/.yfm

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

package/tests/mocks/skip-html-extension/monolingual/input/folder/index.md

@@ -0,0 +1 @@
+# Page 3

package/tests/mocks/skip-html-extension/monolingual/input/index-test-html/index.md

@@ -0,0 +1,4 @@
+# Folder
+
+[Link 1](../page1.md)
+[Link 2](../page2.md)

package/tests/mocks/skip-html-extension/monolingual/input/index.md

@@ -0,0 +1,6 @@
+# Header
+
+Content
+
+[Link 1](page1.md)
+[Link 2](page2.md)

package/tests/mocks/skip-html-extension/monolingual/input/page1.md

@@ -0,0 +1,3 @@
+# Page 1
+
+[Link](page2.md#hash)

package/tests/mocks/skip-html-extension/monolingual/input/page2.md

@@ -0,0 +1,6 @@
+# Page 2
+
+## hash
+
+[Link](./folder/index.md)
+[External link](https://example.com)

package/tests/mocks/skip-html-extension/monolingual/input/toc.yaml

@@ -0,0 +1,13 @@
+title: Skip html extension
+href: index.md
+
+items:
+  - name: Title 1
+    href: page1.md
+  - name: Title 2
+    href: page2.md
+  - name: Title 3
+    href: ./folder/index.md
+  - name: Title 4
+    href: ./index-test-html/index.md
+    

package/tests/mocks/skip-html-extension/multilingual/input/.yfm

@@ -0,0 +1,2 @@
+allowHtml: true
+langs: ['en','ru']

package/tests/mocks/skip-html-extension/multilingual/input/en/folder/index.md

@@ -0,0 +1 @@
+# Page 3

package/tests/mocks/skip-html-extension/multilingual/input/en/index-test-html/index.md

@@ -0,0 +1,4 @@
+# Folder
+
+[Link 1](../page1.md)
+[Link 2](../page2.md)

package/tests/mocks/skip-html-extension/multilingual/input/en/index.md

@@ -0,0 +1,6 @@
+# Header
+
+Content
+
+[Link 1](page1.md)
+[Link 2](page2.md)

package/tests/mocks/skip-html-extension/multilingual/input/en/page1.md

@@ -0,0 +1,3 @@
+# Page 1
+
+[Link](page2.md#hash)

package/tests/mocks/skip-html-extension/multilingual/input/en/page2.md

@@ -0,0 +1,6 @@
+# Page 2
+
+## hash
+
+[Link](./folder/index.md)
+[External link](https://example.com)