Актуализирован README
This commit is contained in:
@@ -1,8 +1,32 @@
|
||||
# Документация iptvc
|
||||
# Документация m3u.su
|
||||
|
||||
Как работать с документацией: [content/dev/docs.md](content/dev/docs.md)
|
||||
Документация построена на [Zensical](https://zensical.org) (MkDocs-совместимый движок).
|
||||
|
||||
## Быстрый старт
|
||||
|
||||
```bash
|
||||
# Сборка статического сайта
|
||||
make site
|
||||
|
||||
# Просмотр в режиме live
|
||||
make live
|
||||
```
|
||||
|
||||
## Структура
|
||||
|
||||
- `content/` — исходники документации (Markdown)
|
||||
- `zensical.toml` — конфигурация сайта
|
||||
- `overrides/` — кастомные темы и иконки
|
||||
- `snippets/` — переиспользуемые фрагменты
|
||||
- `site/` — скомпилированный статический сайт
|
||||
|
||||
## Правила оформления
|
||||
|
||||
См. [content/iptvc/dev/docs.md](content/iptvc/dev/docs.md).
|
||||
|
||||
## Лицензия
|
||||
|
||||
Исходный код и готовая документация распространяется на условиях лицензии MIT.
|
||||
Исходный код и готовая документация распространяется на условиях лицензии MIT.
|
||||
См. файл [LICENSE](LICENSE) для подробностей.
|
||||
|
||||
Стороннее ПО и ресурсы используются в соответствии лицензиями, указанными в файле [content/legal/foss.md](content/legal/foss.md).
|
||||
|
||||
@@ -14,11 +14,6 @@ icon: material/license
|
||||
--8<-- "licenses/vscode-codicons.txt"
|
||||
```
|
||||
|
||||
??? quote "[ionic-team/ionicons](https://github.com/ionic-team/ionicons/blob/master/LICENSE) — MIT"
|
||||
```
|
||||
--8<-- "licenses/ionicons.txt"
|
||||
```
|
||||
|
||||
??? quote "[zensical/zensical](https://github.com/zensical/zensical/blob/master/LICENSE.md) — MIT"
|
||||
```
|
||||
--8<-- "licenses/zensical.txt"
|
||||
|
||||
Reference in New Issue
Block a user