From 4b49dddff2ce98591a1e51c267263e71595d8316 Mon Sep 17 00:00:00 2001 From: Bakhtovar Gulomov Date: Tue, 20 Feb 2024 19:09:08 +0500 Subject: [PATCH] feat: Convert plop examples to ansi format --- docs/en/guide/getting-started.md | 58 ++++++++++++++------------------ docs/guide/getting-started.md | 58 ++++++++++++++------------------ 2 files changed, 52 insertions(+), 64 deletions(-) diff --git a/docs/en/guide/getting-started.md b/docs/en/guide/getting-started.md index 4c3d8479..32712abe 100644 --- a/docs/en/guide/getting-started.md +++ b/docs/en/guide/getting-started.md @@ -128,54 +128,49 @@ For those who want to add new documentation of the extra to the project, the [pl ::: 2. So you will run the CLI helper and you will see the following message. Use the [[↑]] and [[↓]] keys to select the desired language and press [[Enter]]: - ```sh - $ plop - ? Выберите язык / Choose language (Use arrow keys) + ```ansi + ? Выберите язык / Choose language (Use arrow keys) Русский - > English + > English +  ``` 3. Next, you will be asked to select a documentation template, there are two of them: **Single-page** and **Multi-page documentation**. Select the one you want and press [[Enter]]. - ```sh - $ plop - ? Выберите язык / Choose language English - ? Choose documentation template (Use arrow keys) + ```ansi + ? Выберите язык / Choose language English + ? Choose documentation template (Use arrow keys) Single-page documentation - > Multi-page documentation + > Multi-page documentation  ``` 4. Now you need to give your extra a name and press [[Enter]] as well. - ```sh - $ plop - ? Выберите язык / Choose language English - ? Choose documentation template Multi-page documentation - ? Enter the component name + ```ansi + ? Выберите язык / Choose language English + ? Choose documentation template Multi-page documentation + ? Enter the component name │ ``` 5. Finally, you will need to select the language versions of the documentation. By using the [[↑]] and [[↓]] keys and pressing the [[Space]] you can mark the languages you need. Then press the [[Enter]] button. - ```sh - $ plop - ? Выберите язык / Choose language English - ? Choose documentation template Multi-page documentation - ? Enter the component name myFirstComponent - ? Select the language versions of the documentation (Press to select, to toggle all, to invert - selection, and to proceed) - ( ) Русский - >(*) English + ```ansi + ? Выберите язык / Choose language Русский + ? Choose documentation template Multi-page documentation + ? Enter the component name myFirstComponent + ? Выберите языковые версии документации (Press  to select,  to toggle all,  to invert selection, and  to proceed) + ( ) Русский + >(*) English ``` 6. **Done!** You will see something like this in the terminal. This means that the script has created the necessary structure, and you will have to fill out the documentation for your extra. - ```sh - $ plop - ? Выберите язык / Choose language English - ? Choose documentation template Multi-page documentation - ? Enter the component name myFirstComponent - ? Select the language versions of the documentation English - ✔ +! 8 files added + ```ansi + ? Выберите язык / Choose language Русский + ? Choose documentation template Multi-page documentation + ? Enter the component name myFirstComponent + ? Select the language versions of the documentation English + ✔ +! 8 files added -> \docs\components\myfirstcomponent\events.md -> \docs\components\myfirstcomponent\index.md -> \docs\components\myfirstcomponent\quick-start.md @@ -183,8 +178,7 @@ For those who want to add new documentation of the extra to the project, the [pl -> \docs\components\myfirstcomponent\interface\items.md -> \docs\components\myfirstcomponent\snippets\getcategories.md -> \docs\components\myfirstcomponent\snippets\getitems.md - -> \docs\components\myfirstcomponent\snippets\index.md - Done in 1071.49s. + -> \docs\components\myfirstcomponent\snippets\index.md ``` ::: tip TIP diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 36769ebe..c0f41633 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -130,54 +130,49 @@ VitePress также поставляет инструменты, украшаю ::: 2. Таким образом вы запустите CLI helper и увидите такую картину. Используя клавиши [[↑]] и [[↓]] выберите нужный язык и нажмите [[Enter]]: - ```sh - $ plop - ? Выберите язык / Choose language (Use arrow keys) - > Русский + ```ansi + ? Выберите язык / Choose language (Use arrow keys) + > Русский English +  ``` 3. Далее вам будет предложено выбрать шаблон документации, их два: **Одностраничная** и **Многостраничная**. Выберите нужный и нажмите [[Enter]]. - ```sh - $ plop - ? Выберите язык / Choose language Русский - ? Выберите шаблон документации (Use arrow keys) + ```ansi + ? Выберите язык / Choose language Русский + ? Выберите шаблон документации (Use arrow keys) Одностраничная документация - > Многостраничная документация + > Многостраничная документация  ``` 4. Теперь вам нужно ввести название вашего компонента и также нажать на [[Enter]]. - ```sh - $ plop - ? Выберите язык / Choose language Русский - ? Выберите шаблон документации Многостраничная документация - ? Введите название компонента + ```ansi + ? Выберите язык / Choose language Русский + ? Выберите шаблон документации Многостраничная документация + ? Введите название компонента │ ``` 5. И наконец вам нужно будет выбрать языковые версии документации. Используя клавиши [[↑]] и [[↓]] и нажатием на [[Пробел]] вы сможете отметить нужные вам языки. Затем нажмите на кнопку [[Enter]]. - ```sh - $ plop - ? Выберите язык / Choose language Русский - ? Выберите шаблон документации Многостраничная документация - ? Введите название компонента myFirstComponent - ? Выберите языковые версии документации (Press to select, to toggle all, to invert - selection, and to proceed) - >(*) Русский - ( ) English + ```ansi + ? Выберите язык / Choose language Русский + ? Выберите шаблон документации Многостраничная документация + ? Введите название компонента myFirstComponent + ? Выберите языковые версии документации (Press  to select,  to toggle all,  to invert selection, and  to proceed) + >(*) Русский + ( ) English ``` 6. **Готово!** Вы увидите примерно такой вывод в терминале. Это значит, что скрипт для вас создал структуру из файлов и папок, а вам останется написать документацию для своего компонента. - ```sh - $ plop - ? Выберите язык / Choose language Русский - ? Выберите шаблон документации Многостраничная документация - ? Введите название компонента myFirstComponent - ? Выберите языковые версии документации Русский - ✔ +! 8 files added + ```ansi + ? Выберите язык / Choose language Русский + ? Выберите шаблон документации Многостраничная документация + ? Введите название компонента myFirstComponent + ? Выберите языковые версии документации Русский + ✔ +! 8 files added -> \docs\components\myfirstcomponent\events.md -> \docs\components\myfirstcomponent\index.md -> \docs\components\myfirstcomponent\quick-start.md @@ -185,8 +180,7 @@ VitePress также поставляет инструменты, украшаю -> \docs\components\myfirstcomponent\interface\items.md -> \docs\components\myfirstcomponent\snippets\getcategories.md -> \docs\components\myfirstcomponent\snippets\getitems.md - -> \docs\components\myfirstcomponent\snippets\index.md - Done in 1071.49s. + -> \docs\components\myfirstcomponent\snippets\index.md ``` ::: tip