@diplodoc/cli 5.46.1 → 5.47.0

package/tests/mocks/translation/dir-files/input/.yfm

@@ -0,0 +1,6 @@
+translate:
+    extract:
+        vars:
+            test: prod
+            skip: dev
+            

package/tests/mocks/translation/dir-files/input/ru/_includes/test.md

@@ -0,0 +1 @@
+## Заголовок include

package/tests/mocks/translation/dir-files/input/ru/_no-translate/exclude.md

@@ -0,0 +1 @@
+## Не переводить

package/tests/mocks/translation/dir-files/input/ru/aboba.md

@@ -0,0 +1,5 @@
+## Заголовок include
+
+<!-- [ссылка на файл не в toc.yaml](./aboba-not-in-toc.md) -->
+
+{% include [Описание](./_includes/test.md) %}

package/tests/mocks/translation/dir-files/input/ru/index.md

@@ -0,0 +1,3 @@
+## Заголовок index
+
+lorem

package/tests/mocks/translation/dir-files/input/ru/nested/a1.md

@@ -0,0 +1,3 @@
+## Included A1
+
+TEST

package/tests/mocks/translation/dir-files/input/ru/nested/folder1/a1.md

@@ -0,0 +1,3 @@
+## Included A1
+
+TEST

package/tests/mocks/translation/dir-files/input/ru/nested/folder1/toc-i.yaml

@@ -0,0 +1,3 @@
+items:
+  - name: A1
+    href: a1.md

package/tests/mocks/translation/dir-files/input/ru/nested/index-yfm.md

@@ -0,0 +1,2 @@
+# Yandex Flavored Markdown
+

package/tests/mocks/translation/dir-files/input/ru/nested/index.yaml

@@ -0,0 +1,24 @@
+title: Diplodoc
+description: Diplodoc - платформа работы с документацией в парадигме Documentation as a Code. 
+meta:
+  title: Метаданные
+  noIndex: true
+links:
+- title: API Yandex Cloud
+  description: Архитектура API Yandex Cloud (урезанная)
+  href: api-design-guide
+- title: API Yandex Cloud Абсолют
+  description: Архитектура API Yandex Cloud (урезанная) с абсолютным путем
+  href: /api-design-guide
+- title: Обзор системы
+  description: Описание платформы, ее основные возможности, особенности и преимущества.
+  href: about.md
+- title: Как попробовать
+  description: С чего начать работу
+  href: how-it-work.md
+- title: Yandex Flavored Markdown
+  description: Описание языка Yandex Flavored Markdown.
+  href: index-yfm.md
+
+   
+  

package/tests/mocks/translation/dir-files/input/ru/nested/not-in-toc.md

@@ -0,0 +1,20 @@
+---
+keywords: яндекс станция макс
+voter: no
+title: Справочник голосовых команд для Яндекс Станции — Справка
+---
+
+
+aboba
+
+Общение в issues и pull requests в GitHub на русском и преимущественно английском языке.- Презентация/продвижение продукта на разных **![i](./complex/_images/camera.svg) [конференциях](*conference)**{.photo} и **![i](./complex/_images/camera.svg) [митапах](*meetup)**{.photo}.
+
+абоба тест
+
+{% include [Описание](./_includes/test.md) %}
+
+[*meetup]:
+![i](./_images/highload.png)
+
+[*conference]:
+![i](./_images/highload.png)

package/tests/mocks/translation/dir-files/input/ru/nested/syntax/base.md

@@ -0,0 +1,3 @@
+# Базовая разметка
+
+{% if test == "dev" %}[will be deleted on translate-extract](./index.md){% endif %}

package/tests/mocks/translation/dir-files/input/ru/nested/syntax/index.md

@@ -0,0 +1,2 @@
+# Синтаксис
+

package/tests/mocks/translation/dir-files/input/ru/nested/syntax/lists.md

@@ -0,0 +1 @@
+# Списки

package/tests/mocks/translation/dir-files/input/ru/nested/toc.yaml

@@ -0,0 +1,19 @@
+title: Diplodoc
+href: index.yaml
+items:
+  - name: API Yandex Cloud
+    href: index.yaml
+  - include: {mode: merge, path: folder1/toc-i.yaml}
+  - name: Yandex Flavored Markdown
+    href:
+    items:
+      - name: Синтаксис
+        items:
+          - name: Обзор
+            href: syntax/index.md
+          - name: Базовая разметка
+            href: syntax/base.md
+          - name: Списки
+            href: syntax/lists.md
+  - name: Was filtered above
+    href: use_filtered_above.md

package/tests/mocks/translation/dir-files/input/ru/nested/use_filtered_above.md

@@ -0,0 +1,4 @@
+### Theese links were filtered
+
+[test2](./syntax/base.md)
+[test3](./syntax/lists.md)

package/tests/mocks/translation/dir-files/input/ru/no-var-page.md

@@ -0,0 +1,3 @@
+## No var page
+
+This page might be translated or not. Depends on --strict-vars option.

package/tests/mocks/translation/dir-files/input/ru/not-in-toc.md

@@ -0,0 +1,20 @@
+---
+keywords: яндекс станция макс
+voter: no
+title: Справочник голосовых команд для Яндекс Станции — Справка
+---
+
+
+aboba
+
+Общение в issues и pull requests в GitHub на русском и преимущественно английском языке.- Презентация/продвижение продукта на разных **![i](./complex/_images/camera.svg) [конференциях](*conference)**{.photo} и **![i](./complex/_images/camera.svg) [митапах](*meetup)**{.photo}.
+
+абоба тест
+
+{% include [Описание](./_includes/test.md) %}
+
+[*meetup]:
+![i](./_images/highload.png)
+
+[*conference]:
+![i](./_images/highload.png)

package/tests/mocks/translation/dir-files/input/ru/to-be-excluded.md

@@ -0,0 +1 @@
+## Excluded title

package/tests/mocks/translation/dir-files/input/ru/toc.yaml

@@ -0,0 +1,13 @@
+title: Test123
+href: index.md
+items:
+  - name: Aboba
+    href: aboba.md
+  - name: Не переводить
+    when: skip == 'prod'
+    href: _no-translate/exclude.md
+  - name: Нет переменной в vars
+    when: novar == 'test'
+    href: no-var-page.md
+  - name: exclude-test
+    href: to-be-excluded.md

package/tests/mocks/translation/no-translate/input/index.md

@@ -0,0 +1,7 @@
+## Index header
+
+::no-translate  [adsfasdfasdfasdfasdf]
+
+lorem
+
+asdfasdfasdf

package/tests/mocks/translation/no-translate/input/no-translate.md

@@ -0,0 +1,57 @@
+# No-translate directive
+
+## Block directive
+:::no-translate
+### No-translate header
+
+:::html-block
+testsetsets
+:::
+
+::: any-other-directive
+content test
+:::
+
+Should not be translated.
+Can use **markup** inside.
+:::
+
+
+::: some-other-directive
+content here
+:::
+::: no-translate
+content here
+::: some-other-directive
+nested content
+:::
+:::
+
+## Leaf directive
+
+::no-translate [## /usr/local/bin/application]
+::no-translate[**C:\Program Files\Application\config.ini**]
+::no-translate [~/Documents/project/src/main.rs]
+
+
+- :no-translate[GET /api/v1/users] — get all users
+- :no-translate[POST /api/v1/auth/login] — authorization
+- :no-translate[PUT /api/v1/users/{id}] — update users data
+
+## Simple case leaf
+Install using command.
+:no-translate[The default port is unless specified.] Next sentence.
+Set NODE_ENV=production for production builds.
+
+## Simple case inline
+Install using :no-translate[npm install @company/package] command.
+The default port is :no-translate[8080] unless specified.
+Set :no-translate[NODE_ENV=production] for production builds.
+
+## Few inline directives
+Use :no-translate[**GET /api/v1/users**] to list users and :no-translate[POST /api/v1/users] to create.
+
+## Empty inline directive
+This is text with empty :no-translate[] directive.
+
+

package/tests/mocks/translation/no-translate/input/openapi-spec.yaml

@@ -0,0 +1,37 @@
+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 :no-translate[skip this] operation with no inputs and a complex
+      operationId: getWithPayloadResponse
+      responses:
+        "200":
+          description: 200!!!!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RecurceTop'
+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'

package/tests/mocks/translation/no-translate/input/toc.yaml

@@ -0,0 +1,11 @@
+title: Test123
+href: index.md
+items:
+  - name: Не переводить
+    href: no-translate.md
+  - name: openapi
+    include:
+      path: openapi
+      includers:
+        - name: openapi
+          input: openapi-spec.yaml

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

@@ -0,0 +1,50 @@
+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'
+components:
+  schemas:
+    ResolvingCaseChild:
+      description: Child description
+    RecurceTop:
+      type: object
+      properties:
+        A:
+          type: string
+          description: |
+            Статус загрузки:
+            - `UPLOADED` — загрузка завершена.
+            - `IN_PROGRESS` — загрузка находится в процессе обработки.
+            - `PROCESSED` — загрузка успешно обработана.
+    #          $ref: '#/components/schemas/RecurceMiddle'
+    RecurceMiddle:
+      type: object
+      properties:
+        B:
+          type: array
+          items:
+            $ref: '#/components/schemas/RecurceTop'
+    ResolvingCase:
+      type: object
+      properties:
+          withrefprop:
+            description: Parent description
+            $ref: '#/components/schemas/ResolvingCaseChild'

package/tests/mocks/translation/openapi/input/toc.yaml

@@ -0,0 +1,8 @@
+items:
+  - name: openapi
+    include:
+      path: openapi
+      includers:
+        - name: openapi
+          input: openapi-spec.yaml
+      mode: link

package/tests/mocks/translation/toc-include/input/included-toc/merged-included-toc-item.md

@@ -0,0 +1 @@
+#### Included toc item 

package/tests/mocks/translation/toc-include/input/included-toc/toc.yaml

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

package/tests/mocks/translation/toc-include/input/included-toc.md

@@ -0,0 +1 @@
+### Included toc

package/tests/mocks/translation/toc-include/input/index.md

@@ -0,0 +1,7 @@
+## Index header
+
+::no-translate  [adsfasdfasdfasdfasdf]
+
+lorem
+
+asdfasdfasdf

package/tests/mocks/translation/toc-include/input/merged-included-toc-item.md

@@ -0,0 +1 @@
+#### Included toc item 

package/tests/mocks/translation/toc-include/input/no-translate.md

@@ -0,0 +1,57 @@
+# No-translate directive
+
+## Block directive
+:::no-translate
+### No-translate header
+
+:::html-block
+testsetsets
+:::
+
+::: any-other-directive
+content test
+:::
+
+Should not be translated.
+Can use **markup** inside.
+:::
+
+
+::: some-other-directive
+content here
+:::
+::: no-translate
+content here
+::: some-other-directive
+nested content
+:::
+:::
+
+## Leaf directive
+
+::no-translate [## /usr/local/bin/application]
+::no-translate[**C:\Program Files\Application\config.ini**]
+::no-translate [~/Documents/project/src/main.rs]
+
+
+- :no-translate[GET /api/v1/users] — get all users
+- :no-translate[POST /api/v1/auth/login] — authorization
+- :no-translate[PUT /api/v1/users/{id}] — update users data
+
+## Simple case leaf
+Install using command.
+:no-translate[The default port is unless specified.] Next sentence.
+Set NODE_ENV=production for production builds.
+
+## Simple case inline
+Install using :no-translate[npm install @company/package] command.
+The default port is :no-translate[8080] unless specified.
+Set :no-translate[NODE_ENV=production] for production builds.
+
+## Few inline directives
+Use :no-translate[**GET /api/v1/users**] to list users and :no-translate[POST /api/v1/users] to create.
+
+## Empty inline directive
+This is text with empty :no-translate[] directive.
+
+

package/tests/mocks/translation/toc-include/input/openapi-spec.yaml

@@ -0,0 +1,37 @@
+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 :no-translate[skip this] operation with no inputs and a complex
+      operationId: getWithPayloadResponse
+      responses:
+        "200":
+          description: 200!!!!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RecurceTop'
+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'

package/tests/mocks/translation/toc-include/input/toc.yaml

@@ -0,0 +1,14 @@
+title: Test123
+href: index.md
+items:
+  - name: Не переводить
+    href: no-translate.md
+  - name: openapi
+    include:
+      path: openapi
+      includers:
+        - name: openapi
+          input: openapi-spec.yaml
+  - name: Included TOC
+    href: included-toc.md
+    include: { mode: merge, path: included-toc/toc.yaml }

package/tests/mocks/translation/yaml-scheme/input/ru/.yfm

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

package/tests/mocks/translation/yaml-scheme/input/ru/index-direct.yaml

@@ -0,0 +1,133 @@
+meta:
+ title: Справка Сервиса
+ description: В Справке Сервиса собрали всю необходимую информацию.
+ 
+fullScreen: true
+blocks:
+  - type: header-block
+    title: <div class="u-breadcrumbs"></div> 
+    breadcrumbs:
+     items:
+      - text: Справка
+        url: 'https://site.ru/support/'
+      - text: Реклама
+        url: 'https://site.ru/support/adv/'
+  - type: 'filter-block'
+    centered: false
+    title:
+      text: 'Сервис'
+    tags:
+      - id: 'one'
+        label: 'Для специалистов'
+      - id: 'two'
+        label: 'Для предпринимателей'
+    colSizes:
+      all: 12
+      xl: 4
+      sm: 6
+      md: 4
+
+    items:
+      - tags:
+          - 'one'
+        card:
+          type: 'image-card'
+          image: 'https://site.ru/img/orig'
+          title: 'Единая перфоманс-кампания'
+          text: '<div>Комплексно решайте любые перфоманс-задачи в рамках одной кампании</div><div class="u-card__more">Подробнее</>'
+          margins: 'm'
+          border: shadow
+          url: 'unified-performance-campaign/about.md'
+          urlTitle: 'Подробнее'
+
+      - tags:
+          - 'one'
+        card:
+          type: 'image-card'
+          image: 'https://site.ru/img2/orig'
+          title: 'Товарная кампания'
+          text: '<div>Используйте простой инструмент для продвижения товаров интернете</div><div class="u-card__more">Подробнее</>'
+          margins: 'm'
+          border: shadow
+          url: 'campaign-master/product-campaign.md'
+          urlTitle: 'Подробнее'
+
+      - tags:
+          - 'one'
+        card:
+          type: 'image-card'
+          image: 'https://site.ru/img2/orig'
+          title: 'Реклама в Telegram'
+          text: '<div>Покажите релевантную рекламу в телеграм-каналах партнеров РСЯ</div><div class="u-card__more">Подробнее</>'
+          margins: 'm'
+          border: shadow
+          url: 'efficiency/telegram-ads.md'
+          urlTitle: 'Подробнее'
+
+      - tags:
+          - 'one'
+        card:
+          type: 'background-card'
+          title: Часто ищут
+          text: ''
+          backgroundColor: '#F3F6FC'
+          border: line
+          links:
+            - text: Статистика
+              url: 'statistics.md'
+              arrow: true
+              theme: 'normal'
+            - text: Управление фидами
+              url: 'feeds/about.md'
+              arrow: true
+              theme: 'normal'
+
+      - tags:
+          - 'one'
+        card:
+          type: background-card
+          title: Сервисные функции
+          text: ''
+          backgroundColor: '#F3F6FC'
+          border: line
+          links:
+            - text: Правила и модерация
+              url: 'moderation/adv-rules.md'
+              arrow: true
+              theme: 'normal'
+            - text: Технологии и сервисы
+              url: 'technologies-and-services/technologies-and-services.md'
+              arrow: true
+              theme: 'normal'
+            - text: Поддержка 24/7
+              url: 'troubleshooting/other.md'
+              arrow: true
+              theme: 'normal'
+
+      - tags:
+          - 'one'
+        card:
+          type: background-card
+          title: Полезные ссылки
+          text: ''
+          backgroundColor: '#F3F6FC'
+          border: line
+          links:
+            - text: Глоссарий
+              url: 'glossary.md'
+              arrow: true
+              theme: 'normal'
+
+      - tags:
+          - 'two'
+        card:
+          type: 'image-card'
+          image: 'https://site.ru/img4/orig'
+          title: 'Простой старт'
+          text: '<div>Минимум ручных настроек: достаточно указать ссылку на сайт</div><div class="u-card__more">Подробнее</>'
+          margins: 'm'
+          border: shadow
+          url: 'products-automatic/about.md'
+          urlTitle: 'Подробнее'
+
+animated: false

package/tests/mocks/translation/yaml-scheme/input/ru/index.yaml

@@ -0,0 +1,32 @@
+blocks:
+  - type: 'content-layout-block'
+    textWidth: 'l'
+    textContent:
+      title: 'Введение'
+      text: "
+       API сервиса:
+       - Управлять счетчиками, их настройками и правами доступа, не используя веб-интерфейс.\n
+       - Получать информацию о посещаемости сайта и другие данные.\n
+       - Формировать отчеты, в том числе с помощью сегментации и параметризации.\n
+       "
+  - type: 'card-layout-block'
+    colSizes:
+      all: 12
+      lg: 4
+      md: 6
+      sm: 12
+      xl: 4
+    indent:
+      bottom: 'xs'
+    title: 'Виды API'
+    animated: false
+    children:
+      - type: 'basic-card'
+        title: 'API управления'
+        text: "Управление счетчиками, целями, фильтрами и другими объектами Сервиса (например, создать счетчик, отредактировать его настройки, создать цель, выдать права доступа)."
+        urlTitle: 'API управления'
+        border: 'shadow'
+        controlPosition: 'content'
+        url: 'management/index'
+        target: ''
+        animated: false