Skip to content

Commit 4b49ddd

Browse files
feat: Convert plop examples to ansi format
1 parent 625093e commit 4b49ddd

File tree

2 files changed

+52
-64
lines changed

2 files changed

+52
-64
lines changed

docs/en/guide/getting-started.md

+26-32
Original file line numberDiff line numberDiff line change
@@ -128,63 +128,57 @@ For those who want to add new documentation of the extra to the project, the [pl
128128
:::
129129
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]]:
130130
131-
```sh
132-
$ plop
133-
? Выберите язык / Choose language (Use arrow keys)
131+
```ansi
132+
? Выберите язык / Choose language (Use arrow keys)
134133
Русский
135-
> English
134+
> English
135+

136136
```
137137
138138
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]].
139139
140-
```sh
141-
$ plop
142-
? Выберите язык / Choose language English
143-
? Choose documentation template (Use arrow keys)
140+
```ansi
141+
? Выберите язык / Choose language English
142+
? Choose documentation template (Use arrow keys)
144143
Single-page documentation
145-
> Multi-page documentation
144+
[0;36m> Multi-page documentation[0m [0m[0m[0m
146145
```
147146
148147
4. Now you need to give your extra a name and press [[Enter]] as well.
149148
150-
```sh
151-
$ plop
152-
? Выберите язык / Choose language English
153-
? Choose documentation template Multi-page documentation
154-
? Enter the component name
149+
```ansi
150+
? Выберите язык / Choose language English
151+
? Choose documentation template Multi-page documentation
152+
? Enter the component name │
155153
```
156154
157155
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.
158156
159-
```sh
160-
$ plop
161-
? Выберите язык / Choose language English
162-
? Choose documentation template Multi-page documentation
163-
? Enter the component name myFirstComponent
164-
? Select the language versions of the documentation (Press <space> to select, <a> to toggle all, <i> to invert
165-
selection, and <enter> to proceed)
166-
( ) Русский
167-
>(*) English
157+
```ansi
158+
? Выберите язык / Choose language Русский
159+
? Choose documentation template Multi-page documentation
160+
? Enter the component name myFirstComponent
161+
? Выберите языковые версии документации (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
162+
( ) Русский
163+
>(*) English
168164
```
169165
170166
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.
171167
172-
```sh
173-
$ plop
174-
? Выберите язык / Choose language English
175-
? Choose documentation template Multi-page documentation
176-
? Enter the component name myFirstComponent
177-
? Select the language versions of the documentation English
178-
✔ +! 8 files added
168+
```ansi
169+
? Выберите язык / Choose language Русский
170+
? Choose documentation template Multi-page documentation
171+
? Enter the component name myFirstComponent
172+
? Select the language versions of the documentation English
173+
✔ +! 8 files added
179174
-> \docs\components\myfirstcomponent\events.md
180175
-> \docs\components\myfirstcomponent\index.md
181176
-> \docs\components\myfirstcomponent\quick-start.md
182177
-> \docs\components\myfirstcomponent\interface\categories.md
183178
-> \docs\components\myfirstcomponent\interface\items.md
184179
-> \docs\components\myfirstcomponent\snippets\getcategories.md
185180
-> \docs\components\myfirstcomponent\snippets\getitems.md
186-
-> \docs\components\myfirstcomponent\snippets\index.md
187-
Done in 1071.49s.
181+
-> \docs\components\myfirstcomponent\snippets\index.md
188182
```
189183
190184
::: tip TIP

docs/guide/getting-started.md

+26-32
Original file line numberDiff line numberDiff line change
@@ -130,63 +130,57 @@ VitePress также поставляет инструменты, украшаю
130130
:::
131131
2. Таким образом вы запустите CLI helper и увидите такую картину. Используя клавиши [[&uarr;]] и [[&darr;]] выберите нужный язык и нажмите [[Enter]]:
132132
133-
```sh
134-
$ plop
135-
? Выберите язык / Choose language (Use arrow keys)
136-
> Русский
133+
```ansi
134+
? Выберите язык / Choose language (Use arrow keys)
135+
> Русский
137136
English
137+

138138
```
139139
140140
3. Далее вам будет предложено выбрать шаблон документации, их два: **Одностраничная** и **Многостраничная**. Выберите нужный и нажмите [[Enter]].
141141
142-
```sh
143-
$ plop
144-
? Выберите язык / Choose language Русский
145-
? Выберите шаблон документации (Use arrow keys)
142+
```ansi
143+
? Выберите язык / Choose language Русский
144+
? Выберите шаблон документации (Use arrow keys)
146145
Одностраничная документация
147-
> Многостраничная документация
146+
[0;36m> Многостраничная документация[0m [0m[0m[0m
148147
```
149148
150149
4. Теперь вам нужно ввести название вашего компонента и также нажать на [[Enter]].
151150
152-
```sh
153-
$ plop
154-
? Выберите язык / Choose language Русский
155-
? Выберите шаблон документации Многостраничная документация
156-
? Введите название компонента
151+
```ansi
152+
? Выберите язык / Choose language Русский
153+
? Выберите шаблон документации Многостраничная документация
154+
? Введите название компонента │
157155
```
158156
159157
5. И наконец вам нужно будет выбрать языковые версии документации. Используя клавиши [[&uarr;]] и [[&darr;]] и нажатием на [[Пробел]] вы сможете отметить нужные вам языки. Затем нажмите на кнопку [[Enter]].
160158
161-
```sh
162-
$ plop
163-
? Выберите язык / Choose language Русский
164-
? Выберите шаблон документации Многостраничная документация
165-
? Введите название компонента myFirstComponent
166-
? Выберите языковые версии документации (Press <space> to select, <a> to toggle all, <i> to invert
167-
selection, and <enter> to proceed)
168-
>(*) Русский
169-
( ) English
159+
```ansi
160+
? Выберите язык / Choose language Русский
161+
? Выберите шаблон документации Многостраничная документация
162+
? Введите название компонента myFirstComponent
163+
? Выберите языковые версии документации (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
164+
>(*) Русский
165+
( ) English
170166
```
171167
172168
6. **Готово!** Вы увидите примерно такой вывод в терминале. Это значит, что скрипт для вас создал структуру из файлов и папок, а вам останется написать документацию для своего компонента.
173169
174-
```sh
175-
$ plop
176-
? Выберите язык / Choose language Русский
177-
? Выберите шаблон документации Многостраничная документация
178-
? Введите название компонента myFirstComponent
179-
? Выберите языковые версии документации Русский
180-
✔ +! 8 files added
170+
```ansi
171+
? Выберите язык / Choose language Русский
172+
? Выберите шаблон документации Многостраничная документация
173+
? Введите название компонента myFirstComponent
174+
? Выберите языковые версии документации Русский
175+
✔ +! 8 files added
181176
-> \docs\components\myfirstcomponent\events.md
182177
-> \docs\components\myfirstcomponent\index.md
183178
-> \docs\components\myfirstcomponent\quick-start.md
184179
-> \docs\components\myfirstcomponent\interface\categories.md
185180
-> \docs\components\myfirstcomponent\interface\items.md
186181
-> \docs\components\myfirstcomponent\snippets\getcategories.md
187182
-> \docs\components\myfirstcomponent\snippets\getitems.md
188-
-> \docs\components\myfirstcomponent\snippets\index.md
189-
Done in 1071.49s.
183+
-> \docs\components\myfirstcomponent\snippets\index.md
190184
```
191185
192186
::: tip

0 commit comments

Comments
 (0)