https://github.com/bybatkhuu/docs.bybatkhuu.dev
This is bybatkhuu's documentation, wiki, manuals, tips and blog.
https://github.com/bybatkhuu/docs.bybatkhuu.dev
blog docs documentation manuals mkdocs mkdocs-material tips wiki
Last synced: about 1 month ago
JSON representation
This is bybatkhuu's documentation, wiki, manuals, tips and blog.
- Host: GitHub
- URL: https://github.com/bybatkhuu/docs.bybatkhuu.dev
- Owner: bybatkhuu
- License: mit
- Created: 2025-08-27T12:20:06.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-04-26T05:18:11.000Z (about 2 months ago)
- Last Synced: 2026-04-26T07:16:54.648Z (about 2 months ago)
- Topics: blog, docs, documentation, manuals, mkdocs, mkdocs-material, tips, wiki
- Language: Shell
- Homepage: http://docs.bybatkhuu.dev
- Size: 1.35 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# bybatkhuu's Docs
[](https://choosealicense.com/licenses/mit)
[](https://github.com/bybatkhuu/docs.bybatkhuu.dev/actions/workflows/4.publish-docs.yml)
[](https://github.com/bybatkhuu/docs.bybatkhuu.dev/releases)
This is bybatkhuu's documentation, wiki, manuals, tips and blog.
## ✨ Features
- MkDocs Material
- Wiki/Knowledge base
- Technical blog
- Documentation
- Markdown support
- Static site generator
---
## 🛠 Installation
### 1. 🚧 Prerequisites
- Install **Python (>= v3.10)** and **pip (>= 23)**:
- **[RECOMMENDED] [Miniconda (v3)](https://www.anaconda.com/docs/getting-started/miniconda/install)**
- *[arm64/aarch64] [Miniforge (v3)](https://github.com/conda-forge/miniforge)*
- *[Python virutal environment] [venv](https://docs.python.org/3/library/venv.html)*
[OPTIONAL] For **DEVELOPMENT** environment:
- Install [**git**](https://git-scm.com/downloads)
- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) ([video tutorial](https://www.youtube.com/watch?v=snCP3c7wXw0))
### 2. 📥 Download or clone the repository
**2.1.** Prepare projects directory (if not exists):
```sh
# Create projects directory:
mkdir -pv ~/workspaces/projects
# Enter into projects directory:
cd ~/workspaces/projects
```
**2.2.** Follow one of the below options **[A]**, **[B]** or **[C]**:
**OPTION A.** Clone the repository:
```sh
git clone https://github.com/bybatkhuu/docs.bybatkhuu.dev.git && \
cd docs.bybatkhuu.dev
```
**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key):
```sh
git clone git@github.com:bybatkhuu/docs.bybatkhuu.dev.git && \
cd docs.bybatkhuu.dev
```
**OPTION C.** Download source code:
1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/docs.bybatkhuu.dev/releases).
2. Extract it into the projects directory.
### 3. 📦 Install dependencies
```sh
# Install 'mkdocs-material' and other dependencies:
pip install -r ./requirements.txt
# Or for DEVELOPMENT (with extra dependencies):
pip install -r ./requirements/requirements.dev.txt
```
### 4. 🏁 Run the documentation server locally (for DEVELOPMENT)
```sh
mkdocs serve -a 0.0.0.0:8000
# Or:
./scripts/docs.sh
```
### 5. 🌐 Check the documentation in web browser
-
### 6. 🏗️ Generate the HTML documentation files (static site)
```sh
mkdocs build
# Or:
./scripts/build.sh
# Check the generated HTML files (it should be in the `site` directory):
ls -al ./site
```
👍
---
## 📑 References
-
-
-
-
-
-
-
-
-
-