diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..52ec4e3 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,60 @@ +

+ logo +

+ + ReDeathmatch_AMXX + + Documentation +
+ + Build status + + Built with Material for MkDocs +

+

+ +You've found the ReDeathmatch_AMXX documentation GitHub repository, which contains the content for the [ReDeathmatch_AMXX documentation](https://redeathmatch.github.io/). + +If you are looking for the ReDeathmatch_AMXX product GitHub repository, you can find it [here](https://github.com/ReDeathmatch/ReDeathmatch_AMXX). + +## Documentation Issues + +To enter documentation bugs, please create a [new GitHub issue](https://github.com/ReDeathmatch/ReDeathmatch.github.io/issues). Please check if there is an existing issue first. + +If you think the issue is with the ReDeathmatch_AMXX product itself, please enter issues in the ReDeathmatch_AMXX product repo [here](https://github.com/ReDeathmatch/ReDeathmatch_AMXX/issues). + +## Workflow +- For small changes, use the "Edit" button on each page to edit the Markdown file directly on GitHub. +- If you plan to make significant changes or preview the Markdown files in VS Code, clone the repo to edit and preview the files directly in VS Code. +![Alt text](assets/image.png) + +### Manual with Python +1. [Install Python and deps for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/) +2. Activate python virtual env + + ```bash + source venv/Scripts/activate + ``` + +3. [Previewing as you write](https://squidfunk.github.io/mkdocs-material/creating-your-site/?h=serve#previewing-as-you-write) + + ```bash + mkdocs serve + ``` + +### or Docker [image use](https://hub.docker.com/r/squidfunk/mkdocs-material/) + +```bash +docker run --rm -it -p 8000:8000 -v /${PWD}:/docs squidfunk/mkdocs-material +``` + +Now you can open local MkDocs server: http://127.0.0.1:8000/ \ No newline at end of file diff --git a/.github/assets/image.png b/.github/assets/image.png new file mode 100644 index 0000000..895c599 Binary files /dev/null and b/.github/assets/image.png differ diff --git a/docs/en/Work-with-documentation.md b/docs/en/Work-with-documentation.md index 91d117b..d27db2c 100644 --- a/docs/en/Work-with-documentation.md +++ b/docs/en/Work-with-documentation.md @@ -1,18 +1,21 @@ ### Manual with Python 1. [Install Python and deps for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/) 2. Activate python virtual env -```bash -source venv/Scripts/activate -``` -2. [Previewing as you write](https://squidfunk.github.io/mkdocs-material/creating-your-site/?h=serve#previewing-as-you-write) -```bash -mkdocs serve -``` -### Docker [image use](https://hub.docker.com/r/squidfunk/mkdocs-material/) + ```bash + source venv/Scripts/activate + ``` + +3. [Previewing as you write](https://squidfunk.github.io/mkdocs-material/creating-your-site/?h=serve#previewing-as-you-write) + + ```bash + mkdocs serve + ``` + +### or Docker [image use](https://hub.docker.com/r/squidfunk/mkdocs-material/) + ```bash docker run --rm -it -p 8000:8000 -v /${PWD}:/docs squidfunk/mkdocs-material ``` -and open local MkDocs server: [http://127.0.0.1:8000/ReDeathmatch/](http://127.0.0.1:8000/ReDeathmatch/) - +Now you can open local MkDocs server: http://127.0.0.1:8000/ \ No newline at end of file diff --git a/docs/ru/Work-with-documentation.md b/docs/ru/Work-with-documentation.md index 0bb074e..6f28fc7 100644 --- a/docs/ru/Work-with-documentation.md +++ b/docs/ru/Work-with-documentation.md @@ -1,17 +1,21 @@ -### Работа с использованием Python -1. [Установка Python и зависимостей для MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/) -2. Активируйте Python виртуальное окружение -```bash -source venv/Scripts/activate -``` +### Руководство с использованием Python +1. [Установите Python и зависимости для MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/) +2. Активируйте виртуальное окружение Python + + ```bash + source venv/Scripts/activate + ``` + 3. [Предварительный просмотр при написании](https://squidfunk.github.io/mkdocs-material/creating-your-site/?h=serve#previewing-as-you-write) -```bash -mkdocs serve -``` -### Использование Docker-образа [image use](https://hub.docker.com/r/squidfunk/mkdocs-material/) + ```bash + mkdocs serve + ``` + +### или используйте Docker [образ](https://hub.docker.com/r/squidfunk/mkdocs-material/) + ```bash docker run --rm -it -p 8000:8000 -v /${PWD}:/docs squidfunk/mkdocs-material ``` -и откройте локальный сервер MkDocs: [http://127.0.0.1:8000/ReDeathmatch/](http://127.0.0.1:8000/ReDeathmatch/) \ No newline at end of file +Теперь вы можете открыть локальный сервер MkDocs: http://127.0.0.1:8000/ \ No newline at end of file