diplodoc-platform / diplodoc-platform/docs

Доработать страницу документации Дополнительные плагины

Open
#109 0 comments 0 reactions 0 assignees View on GitHub
enhancement from_support
Dominant language
CSS
Stars
11
Forks
38
Avg merge
14h 51m
Merged PRs (30d)
15

Description

### Какую проблему решит эта функция?/What is the problem this?
Пытаюсь добавить в проект, созданный по шаблону, диаграмму на PlantUML, но пока безуспешно.
Согласно инструкции, необходимо вставить код диаграммы в определённое место, однако в шаблоне присутствуют только файлы с расширениями .md, .yml и .yfm.

По инструкции не совсем понятно, как правильно подключать плагины.

### Какую функцию вы предлагаете для решения этой проблемы?/What is the feature you are proposing to solve the problem?
Переформулируйте, пожалуйста, инструкции по подключению плагинов.

Ссылка на документацию: https://diplodoc.com/docs/ru/plugins/import

Инструкция от дежурного сервиса:

1. Скачиваем клишку `git clone https://github.com/diplodoc-platform/cli.git`.

2. Устанавливаем зависимости и билдим `npm i & npm run build`.

3. Переходим в папку `build` и создаем файл `index.js` со следующим контентом:

const plantum = require('markdown-it-plantuml');
module.exports = [
plantum
];

4. Добавляем в любую md-страницу plantuml-диаграмму.

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml

5. Теперь диаграммы рендерятся.

### Какие альтернативы вы рассматривали?/What alternatives have you considered?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.