add readme, new structure

GeTechG · Nov 16, 2023 · d36ff22 · d36ff22
1 parent 64ab5b4
commit d36ff22
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,56 @@
-install:
-1. read https://www.mkdocs.org/user-guide/installation/
-2. `pip install mkdocs-material`
+## Installation
 
-test: `mkdocs serve`
+### 1. Install Python 3.8
 
-build: ```mkdocs gh-deploy --force```
+Make sure you have Python version 3.8 or higher installed. You can download it from the [official Python website](https://www.python.org/downloads/).
+
+### 2. Install MkDocs and Material Theme
+
+Open the Command Prompt and execute the following commands:
+
+```sh
+pip install mkdocs
+pip install mkdocs-material
+```
+
+## Usage
+
+### Launching the Local Server
+
+For a preview, run:
+
+```sh
+mkdocs serve
+```
+
+Open a web browser and go to [http://127.0.0.1:8000/](http://127.0.0.1:8000/) to view the results.
+
+### Documentation Structure
+
+All documentation is organized within the `docs` folder. Inside this folder, you'll find subfolders with names corresponding to different languages (e.g., `ru`, `en`, etc.). The root `docs` folder also contains the `mkdocs.yml` file, where the main documentation settings are specified.
+
+For more detailed settings, refer to the [official MkDocs website](https://www.mkdocs.org/). However, for basic documentation editing, you only need the `nav` section. In this section, you define the documentation structure. In other words, if you want to create a new documentation page, create a file in the format `docs/<language>/<subsection>/my_file.md`.
+
+![](imgs/img_1.jpg)
+
+Then, in the `nav` section of the `mkdocs.yml` file, specify the path to the new page relative to the `docs` folder, following the required structure.
+
+![](imgs/img_2.jpg)
+
+Additionally, you can create an `index.md` file inside a subfolder to automatically generate a page for that subsection. This simplifies navigation through the documentation and makes it more structured.
+![](imgs/img_3.jpg)
+![](imgs/img_4.jpg)
+
+### Markdown Styling Guide
+
+If you are interested in how to format text in Markdown using various styles such as bold, italics, headers, etc., I recommend reading the detailed styling guide. You can find it [here](https://abl3t0nnile.github.io/docs/library/markdown/syntax_guide/).
+
+This guide provides detailed instructions on applying various styles in Markdown, making your text more readable and structured. From using bold and italics to creating headers and lists, you'll find everything you need for effective formatting of your documents. Follow the link to gain a deeper understanding of Markdown syntax and style application.
+
+## Deployment on GitHub Pages
+
+To deploy the documentation on GitHub Pages, run:
+
+```sh
+mkdocs gh-deploy --force
+```
diff --git a/docs/en/getting_started.md b/docs/en/getting_started.md
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -1 +1 @@
-## Hello World
+![pic](../override_assets/pic.jpeg)
diff --git a/docs/ru/getting_started.md b/docs/ru/getting_started.md
diff --git a/docs/ru/index.md b/docs/ru/index.md
@@ -1 +1 @@
-Привет мир!
+LDYOM - это модификация
diff --git a/imgs/img_1.jpg b/imgs/img_1.jpg
diff --git a/imgs/img_2.jpg b/imgs/img_2.jpg
diff --git a/imgs/img_3.jpg b/imgs/img_3.jpg
diff --git a/imgs/img_4.jpg b/imgs/img_4.jpg
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -3,9 +3,11 @@ site_url: https://getechg.github.io/LDYOM_DOC/
 
 nav:
   - Русский:
-    - Индекс: ru
+    - О моде: ru/index.md
+    - Первые шаги: ru/getting_started.md
   - English:
-    - Index: en
+    - About: en/index.md
+    - Getting started: en/getting_started.md
 
 theme:
   name: material