https://github.com/hien-p/hien-p.github.io
https://github.com/hien-p/hien-p.github.io
documentation
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hien-p/hien-p.github.io
- Owner: hien-p
- Created: 2025-07-22T08:13:59.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-09-10T08:47:39.000Z (10 months ago)
- Last Synced: 2025-09-10T12:05:22.318Z (10 months ago)
- Topics: documentation
- Language: JavaScript
- Homepage: https://harriweb3.dev/#
- Size: 15.2 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Harry's Blockchain Documentation 📚
Personal documentation site for blockchain development, Web3 tutorials, and technical resources.
## 🚀 Quick Start
### Development
```bash
# Start the development server
mkdocs serve --dev-addr=127.0.0.1:8001
# Open in browser
open http://127.0.0.1:8001
```
### Auto Navigation System
This project uses an **auto-navigation system** that automatically detects and lists all your markdown files. No need to manually update navigation!
#### When you add new files:
**Quick Update (Recommended)**
```bash
python update_nav.py
```
**Full Navigation Regeneration**
```bash
python generate_full_nav.py
```
## 📁 Project Structure
```
docs/
├── collections/ # Main content collections
│ ├── Layer_0/ # Cross-chain solutions
│ ├── Layer_1/ # Base layer protocols
│ ├── EVM/ # Ethereum Virtual Machine
│ ├── Defi/ # Decentralized Finance
│ ├── Modular_blockchain/ # Scalable architecture
│ └── security researcher/ # Smart contract security
├── What_I_learned_from_VBI_Academy/ # VBI Academy content
├── vibe_coding/ # Development tools
└── weminal/ # Project documentation
```
## 🛠️ Features
- **Auto Navigation**: Automatically detects and lists all `.md` files
- **Responsive Design**: Works on all devices
- **Dark Mode**: Built-in theme switching
- **Search**: Full-text search across all content
- **Mobile Sidebar**: Sliding sidebar on mobile devices
## 📝 Adding New Content
1. **Add your markdown file** to any folder in `docs/collections/`
2. **Run the navigation updater**:
```bash
python update_nav.py
```
3. **That's it!** Your file will automatically appear in the navigation
## 🎯 Collections Overview
### Layer 0 - Cross-chain Solutions
- Polkadot ecosystem
- Interoperability protocols
### Layer 1 - Base Layer Protocols
- Sui development (Move language)
- Avalanche (subnets, AWM)
### EVM - Ethereum Virtual Machine
- EVM internals deep dive
- Smart contract development
### DeFi - Decentralized Finance
- Token standards (ERC-6551)
- DEX protocols (Uniswap V1)
### Modular Blockchain
- Celestia (data availability)
- Camp Mamo learning materials
### Security Researcher
- Smart contract auditing
- Security best practices
## 🔧 Customization
### Theme
Based on **MkDocs Windmill** theme with custom enhancements:
- Custom CSS: `docs/css/custom.css`
- Custom JS: `docs/js/custom.js`
### Configuration
Main config: `mkdocs.yml`
## 📚 Resources
- [MkDocs Documentation](https://www.mkdocs.org/)
- [MkDocs Awesome Pages Plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin)
- [Windmill Theme](https://github.com/gristlabs/mkdocs-windmill)
---
### Đệ trình Sitemap
- Google Search Console (URL-prefix): thêm thuộc tính với URL `https://hien-p.github.io/hari-docs/`, rồi submit sitemap: `https://hien-p.github.io/hari-docs/sitemap.xml`.
- Bing Webmaster Tools: thêm site và submit cùng sitemap URL.
### Lưu ý quan trọng
- Giữ `site_url` chính xác trong `mkdocs.yml` để canonical và sitemap đúng URL.
- `use_directory_urls: true` đã bật để URL gọn và nhất quán.
- Mỗi lần deploy, sitemap tự được cập nhật; không cần thao tác thủ công ngoài Search Console.