https://github.com/n2ref/core2-docs
Документация по проекту core2
https://github.com/n2ref/core2-docs
Last synced: 3 months ago
JSON representation
Документация по проекту core2
- Host: GitHub
- URL: https://github.com/n2ref/core2-docs
- Owner: n2ref
- License: mit
- Created: 2023-09-03T06:10:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T09:24:03.000Z (almost 2 years ago)
- Last Synced: 2025-06-13T23:35:28.199Z (about 1 year ago)
- Homepage: https://n2ref.github.io/core2-docs
- Size: 1.34 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Core2 Docs
Документация по проекту core2
[Online просмотр](https://n2ref.github.io/core2-docs/index.html)
## Установка MkDocs
1) Перейдите на страницу приложения и выполните указанные действия для установки базовой версии.
[MkDocs Installation](https://www.mkdocs.org/user-guide/installation/)
2) Установите несколько плагинов требуемых для сборки
Внешний вид [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
```shell
$ pip install mkdocs-material
```
Плагин для отображения картинок на весь экран.
```shell
$ pip install mkdocs-glightbox
```
[Подробнее](https://squidfunk.github.io/mkdocs-material/getting-started)
## Запуск и сборка сайта документации
Для онлайн просмотра содержимого документации на своем компьютере выполните команду
и после этого перейдите на страницу [localhost:8000](http://localhost:8000)
```shell
$ python -m mkdocs serve
```
Для сборки сайта документации выполните команду
```shell
$ python -m mkdocs build
```
После этого созданный сайт будет помещен в папку `/site` в корне проекта
Более подробно о командах можно узнать на странице приложения - [Command Line Interface](https://www.mkdocs.org/user-guide/cli/)