-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
54d1f31
commit 383d45f
Showing
4 changed files
with
88 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
<p align="center"> | ||
<img | ||
alt="logo" | ||
src="https://user-images.githubusercontent.com/18553678/233882657-0ee4d8ea-2492-4af7-8db5-32430689c131.png" | ||
width="200px" | ||
/> | ||
<h1 align="center"> | ||
<a href="https://github.com/ReDeathmatch/ReDeathmatch_AMXX"> | ||
ReDeathmatch_AMXX | ||
</a> | ||
Documentation | ||
<br> | ||
<a href="https://github.com/ReDeathmatch/ReDeathmatch.github.io/actions/workflows/mkdocs.yml"> | ||
<img | ||
src="https://img.shields.io/github/actions/workflow/status/ReDeathmatch/ReDeathmatch.github.io/mkdocs.yml?branch=master&style=flat-square&logo=github&logoColor=white" | ||
alt="Build status" | ||
></a> | ||
<a href="https://squidfunk.github.io/mkdocs-material/"> | ||
<img src="https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white" | ||
alt="Built with Material for MkDocs" | ||
></a> | ||
</h1> | ||
</p> | ||
|
||
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/ |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/) | ||
Теперь вы можете открыть локальный сервер MkDocs: http://127.0.0.1:8000/ |