1
1
** русский** | [ english] ( https://github.com/yandex-cloud/yfm-transform/blob/master/README.md )
2
- - - -
2
+
3
+ ---
3
4
4
5
[ ![ NPM version] ( https://img.shields.io/npm/v/@diplodoc/transform.svg?style=flat )] ( https://www.npmjs.org/package/@diplodoc/transform )
5
6
11
12
12
13
1 . Установите пакет:
13
14
14
- ``` shell
15
- npm i @diplodoc/transform
16
- ```
15
+ ``` shell
16
+ npm i @diplodoc/transform
17
+ ```
17
18
18
19
1 . Подключите пакет в своем коде, используя функцию ` require() ` или ` import() ` :
19
20
20
- ` ` ` javascript
21
- const transform = require(' @diplodoc/transform' );
22
- ```
21
+ ``` javascript
22
+ const transform = require (' @diplodoc/transform' );
23
+ ```
23
24
24
25
1 . Для корректного отображения подключите в проект CSS-стили и клиентские скрипты:
25
26
26
- ` ` ` css
27
- @import ' ~@diplodoc/transform/dist/css/yfm.css' ;
28
- ` ` `
27
+ ``` css
28
+ @import ' ~@diplodoc/transform/dist/css/yfm.css' ;
29
+ ```
29
30
30
- ` ` ` javascript
31
- import ' @diplodoc/transform/dist/js/yfm' ;
32
- ` ` `
31
+ ``` javascript
32
+ import ' @diplodoc/transform/dist/js/yfm' ;
33
+ ```
33
34
34
35
## Использование {#use}
35
36
36
37
Пакет предоставляет функцию ` transform() ` :
37
- * входные данные — строка с YFM и [настройки](settings.md);
38
- * возвращаемое значение — объект с полями ` result` и ` logs` .
38
+
39
+ - входные данные — строка с YFM и [ настройки] ( settings.md ) ;
40
+ - возвращаемое значение — объект с полями ` result ` и ` logs ` .
39
41
40
42
### Поле result
41
43
42
44
` result ` — объект результата, содержит поля:
43
- * ` html` — строка с HTML.
44
- * ` meta` — [метаданные](../../syntax/meta.md#meta) из переданного контента.
45
- * ` title` — заголовок документа. Возвращается, если заданы настройки ` extractTitle = true` или ` needTitle = true` .
46
- * ` headings` — список заголовков документа.
45
+
46
+ - ` html ` — строка с HTML.
47
+ - ` meta ` — [ метаданные] ( ../../syntax/meta.md#meta ) из переданного контента.
48
+ - ` title ` — заголовок документа. Возвращается, если заданы настройки ` extractTitle = true ` или ` needTitle = true ` .
49
+ - ` headings ` — список заголовков документа.
47
50
48
51
### Поле logs
49
52
50
53
` logs ` — информация о процессе трансформации, включает массивы:
51
- * ` error` — ошибки.
52
- * ` warn` — предупреждения.
53
- * ` info` — дополнительная информация.
54
+
55
+ - ` error ` — ошибки.
56
+ - ` warn ` — предупреждения.
57
+ - ` info ` — дополнительная информация.
54
58
55
59
### Пример вызова функции
56
60
@@ -59,15 +63,14 @@ const fs = require('fs');
59
63
const transform = require (' @diplodoc/transform' );
60
64
61
65
const content = fs .readFileSync (filePath, ' utf' );
62
- const vars = { user: { name: ' Alice' } };
66
+ const vars = {user: {name: ' Alice' } };
63
67
64
68
const {
65
- result: {html, meta, title, headings},
66
- logs,
67
- } = transform(content, {vars});
69
+ result: {html , meta , title , headings },
70
+ logs ,
71
+ } = transform (content, {vars});
68
72
```
69
73
70
-
71
74
## License
72
75
73
76
MIT
0 commit comments