Skip to content

Commit c898f23

Browse files
committed
Добавили инструкции по генерации дифов
1 parent 2874529 commit c898f23

2 files changed

Lines changed: 36 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,15 @@ HeadHunter API — это инструментарий для интеграци
2525
2626
## [OpenAPI](https://api.hh.ru/openapi/redoc)
2727

28-
Доступная в [OpenAPI](https://api.hh.ru/openapi/redoc) документация будет со временем дополняться.
28+
Доступная в [OpenAPI](https://api.hh.ru/openapi/redoc) документация содержит всю актуальную информацию на текущий момент.
2929
Методы, описанные в данной документации и доступные в OpenAPI, имеют соответствующую ссылку.
3030

31-
Спецификация HeadHunter API: [openapi.yml](https://api.hh.ru/openapi/specification/public).
31+
История версий хранится в папке [versions](versions), [/versions/openapi.yml](versions/openapi.yml) содержит общую документацию,
32+
предоставлен для ознакомления, информация в нем может "отставать", поэтому для получения актуальной документации лучше пользоваться страницей https://api.hh.ru/openapi/redoc.
33+
Если не удается посмотреть изменения в файле openapi.yml в конкретном комите ([пример](https://github.com/hhru/api/commit/28745291577c518a72540bc1243415da26cbec64),
34+
github не отображает крупные изменения в виде diff), можно сформировать файл с изменениями самостоятельно по [инструкции](docs/diff_instruction.md).
35+
36+
Актуальная спецификация HeadHunter API: [openapi.yml](https://api.hh.ru/openapi/specification/public).
3237

3338
<a name="content"></a>
3439
## Содержание

docs/diff_instruction.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Получить diff “как на GitHub” для двух больших файлов документации
2+
3+
## Шаг 1 — Сгенерировать diff через git diff
4+
Убедись, что git установлен:
5+
6+
```
7+
git --version
8+
```
9+
Сгенерируй diff для двух файлов и сохрани в файл:
10+
```
11+
git diff --no-index --minimal --histogram -- file1 file2 > changes.diff
12+
```
13+
где file1 и file2 — пути к сравниваемым файлам, файлы документации можно взять в папке [history](////)
14+
15+
16+
## Шаг 2 — Установить diff2html и отрисовать diff в HTML
17+
Проверь, что есть Node.js и npm:
18+
```
19+
node -v
20+
npm -v
21+
```
22+
23+
Сгенерируй HTML (side-by-side как на GitHub):
24+
```
25+
npx diff2html-cli -i file -o preview -s side -- changes.diff
26+
```
27+
28+
# Результат
29+
После выполнения команды выше файл открывается автоматически, если этого не произошло, то надо открыть файл diff.html самостоятельно.

0 commit comments

Comments
 (0)