Skip to content

Commit

Permalink
add included docs
Browse files Browse the repository at this point in the history
  • Loading branch information
makamekm committed Nov 20, 2024
1 parent ced0151 commit 4911911
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 10 deletions.
18 changes: 12 additions & 6 deletions en/tools/docs/included.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

The included: true flag is a configuration parameter that is designed to speed up document processing. It merges all dependent .md files into a single final file, improving performance and simplifying document management.
The "included: true" flag is a configuration parameter that is designed to speed up document processing. It merges all dependent .md files into a single final file, improving performance and simplifying document management.

## Features

Expand Down Expand Up @@ -35,7 +35,7 @@ Once enabled, the system will automatically merge all .md files that are marked
## Example
### Input files
### Input
```md
start main
Expand All @@ -45,29 +45,35 @@ start main
end main
```

```md (included/file-1-deep.md)
#### included/file-1-deep.md

```md
start file 1

{% include [Text](file-2-deep.md) %}

end file 1
```

```md (included/file-2-deep.md)
#### included/file-2-deep.md

```md
start file 2

{% include [Text](file-3.md) %}

end file 2
```

```md (included/file-3.md)
#### included/file-3.md

```md
start file 3

end file 3
```

### Результат
### Result

```md
start main
Expand Down
14 changes: 10 additions & 4 deletions ru/tools/docs/included.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Описание

Флаг included: true — это параметр конфигурации, который предназначен для ускорения обработки документов. Он объединяет все зависимые .md файлы в один конечный файл, что позволяет улучшить производительность и упростить управление документами.
Флаг "included: true" — это параметр конфигурации, который предназначен для ускорения обработки документов. Он объединяет все зависимые .md файлы в один конечный файл, что позволяет улучшить производительность и упростить управление документами.

## Особенности

Expand Down Expand Up @@ -45,23 +45,29 @@ start main
end main
```

```md (included/file-1-deep.md)
#### included/file-1-deep.md

```md
start file 1

{% include [Text](file-2-deep.md) %}

end file 1
```

```md (included/file-2-deep.md)
#### included/file-2-deep.md

```md
start file 2

{% include [Text](file-3.md) %}

end file 2
```

```md (included/file-3.md)
#### included/file-3.md

```md
start file 3

end file 3
Expand Down

0 comments on commit 4911911

Please sign in to comment.