Release 0.3.9: export_docs clean + wiki index pages
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -1,10 +1,12 @@
|
||||
# export_1c_help
|
||||
|
||||
**Версия:** см. [`VERSION`](VERSION) (текущая: **0.3.4**) · [CHANGELOG](CHANGELOG.md)
|
||||
**Версия:** см. [`VERSION`](VERSION) (текущая: **0.3.9**) · [CHANGELOG](CHANGELOG.md)
|
||||
**Лицензия:** [MIT](LICENSE)
|
||||
|
||||
Выгрузка встроенной справки **любой** конфигурации 1С (`**/Ext/Help/ru.html`) в Markdown и публикация в wiki git-репозитория (Gitea / GitLab: `*.wiki.git`).
|
||||
|
||||
Дополнительно: публикация произвольных Markdown-статей в подпапки wiki через `export_docs.py` (спецификация: [`SPEC_EXPORT_DOCS.md`](SPEC_EXPORT_DOCS.md)).
|
||||
|
||||
Зависимости: **Python 3.10+**, только стандартная библиотека.
|
||||
|
||||
---
|
||||
@@ -143,6 +145,37 @@ python3 export_1c_help.py push -c /path/to/config
|
||||
| `convert` | только Markdown на диск |
|
||||
| `push` | convert + commit/push в wiki |
|
||||
|
||||
### Публикация произвольных Markdown-документов
|
||||
|
||||
```bash
|
||||
python3 export_docs.py push \
|
||||
--files ./docs/*.md \
|
||||
--folder docs
|
||||
```
|
||||
|
||||
Если `-s/ -c` не указаны, wiki URL берётся из git remote текущей папки.
|
||||
|
||||
Выгружаются только `.md`, но если внутри них есть локальные ссылки на файлы (картинки/документы), эти файлы тоже копируются в wiki и относительные ссылки сохраняются. Поддерживаются и reference-style ссылки через `[id]: target` (для `[text][id]` переопределения переписываются).
|
||||
|
||||
С сохранением структуры подкаталогов:
|
||||
|
||||
```bash
|
||||
python3 export_docs.py push \
|
||||
--files ./docs/**/*.md \
|
||||
-s /path/to/config/src \
|
||||
--folder migration/docs
|
||||
```
|
||||
|
||||
Очистка опубликованных `export_docs`-страниц из wiki:
|
||||
|
||||
```bash
|
||||
python3 export_docs.py clean \
|
||||
--folder docs \
|
||||
--wiki-url https://git.example/org/repo.wiki.git
|
||||
```
|
||||
|
||||
`clean` не принимает `--files`: удаление идёт по сохранённому `manifest.export_docs.*.json` для указанного `--folder`.
|
||||
|
||||
Общие параметры источника (взаимоисключающие):
|
||||
|
||||
| Параметр | Описание |
|
||||
|
||||
Reference in New Issue
Block a user