Добавлен HTML в markdwon и развит функционал оглавления

DocHubTeam · Jun 10, 2024 · cfc7f58 · cfc7f58
1 parent 69cb5a5
commit cfc7f58
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 7 deletions.
diff --git a/public/documentation/docs/manual/docs/bpmn.md b/public/documentation/docs/manual/docs/bpmn.md
@@ -123,3 +123,13 @@ docs:
 
 ![BPMN](@document/dochub.example.bpmn.analyse)
 
+# BPMN2
+test
+
+## trst
+
+### test 
+
+#### test
+
+##### test
diff --git a/public/documentation/docs/manual/docs/markdown.md b/public/documentation/docs/manual/docs/markdown.md
@@ -1,9 +1,14 @@
 # Markdown
 
-В Markdown документах включена поддержка HTML. Добавлены специальные теги DocHub, которые позволяют
-заметно расширить функциональность:
+Облегчённый язык разметки, созданный с целью обозначения форматирования в простом тексте, 
+с максимальным сохранением его читаемости человеком, и пригодный для машинного
+преобразования в языки для продвинутых публикаций.
 
-## Навигационные якоря
+## Расширенные возможности
+
+Добавлены специальные теги DocHub, которые позволяют заметно расширить функциональность:
+
+### Навигационные якоря
 Позволяет создавать именованные якоря для "коротких" ссылок внутри документа. Например, код:
 ```
 ![](@anchor/markdown)
@@ -13,7 +18,7 @@
 [Пример короткой ссылки](#markdown)
 ```
 
-## Изображения
+### Изображения
 Поддерживается встраивание изображений. Например:
 
 ```
@@ -22,7 +27,7 @@
 
 ![Кот](examples/cat.jpg)
 
-## Ссылки на объекты DocHub
+### Ссылки на объекты DocHub
 Добавляет ссылку на архитектурный объект. Пример для ссылки на документ:
 ```
 [Swagger контракт](/docs/dochub.example.swgr)
@@ -41,7 +46,7 @@
 
 [Компонент gitlab](/architect/components/dochub.gitlab)
 
-## Встраиваемые объекты DocHub
+### Встраиваемые объекты DocHub
 Интегрирует в документ архитектурный объект. Например:
 ```
 ![Компонент архитектуры](@component/dochub.front)
@@ -66,4 +71,33 @@
 
 Через "/" указывается идентификатор объекта. 
 
+## Использование HTML 
+По умолчанию в markdown отключены HTML тэги. Это сделано для исключения встраивания потенциально опасного 
+произвольного кода. Для включения поддержки HTML, используйте переменную окружения VUE_APP_DOCHUB_MARKDOWN_HTML 
+в режиме портала.
+
+```
+VUE_APP_DOCHUB_MARKDOWN_HTML=on
+```
+
+Подробнее [здесь](https://github.com/RabotaRu/DocHub/blob/master/example.env).
+
+Для включения поддержки HTML в плагинах, потребуется установить переменную DOCHUB_IDE_MARKDOWN_HTML на рабочей станции.
+
+Для linux:
+
+```
+export DOCHUB_IDE_MARKDOWN_HTML=on
+```
+
+Для windows:
+```
+set DOCHUB_IDE_MARKDOWN_HTML=on
+```
+
+**ВНИМАНИЕ:** Поддержка HTML не является стандартом markdown. Высока вероятность столкнуться с различными
+проблемами при его использовании. Не рекомендуется использование HTML в Markdown. 
+
+
+
 
diff --git a/src/frontend/components/Docs/DocMarkdown.vue b/src/frontend/components/Docs/DocMarkdown.vue
@@ -6,6 +6,8 @@
     <markdown
       v-if="(markdown !== null)"
       toc
+      v-bind:toc-first-level="0"
+      v-bind:toc-last-level="100"
       v-bind:breaks="false"
       v-bind:html="isHTMLSupport"
       v-bind:postrender="rendered"
@@ -34,6 +36,7 @@
   import DocMixin from './DocMixin';
   import ContextMenu from './DocContextMenu.vue';
   import Spinner from '@front/components/Controls/Spinner.vue';
+  import env from '@front/helpers/env';
 
   export default {
     name: 'DocMarkdown',
@@ -92,7 +95,7 @@
     computed: {
       // Определяет поддерживаются ли HTML тэги в markdown
       isHTMLSupport() {
-        return (process.env.VUE_APP_DOCHUB_MARKDOWN_HTML || 'off').toLocaleLowerCase() === 'on';
+        return (process.env.VUE_APP_DOCHUB_MARKDOWN_HTML || env.ideSettings?.env.DOCHUB_IDE_MARKDOWN_HTML || 'off').toLocaleLowerCase() === 'on';
       },
       // Возвращает URL документа с учетом истории переходов
       currentURL() {
@@ -188,6 +191,11 @@
 
 <style>
 
+.table-of-contents {
+  list-style-type: none;
+  padding-left: 0;
+}
+
 .theme--light.v-application code {
   background: none !important;
 }