https://github.com/minhquan2904/minhquan2904.github.io

gitcus
https://github.com/minhquan2904/minhquan2904.github.io

giscus mkdocs mkdocs-material

Last synced: 3 months ago
JSON representation

gitcus

• Host: GitHub
• URL: https://github.com/minhquan2904/minhquan2904.github.io
• Owner: minhquan2904
• Created: 2024-04-05T02:01:03.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-06-05T09:36:33.000Z (7 months ago)
• Last Synced: 2024-09-26T21:04:08.374Z (4 months ago)
• Topics: giscus, mkdocs, mkdocs-material
• Language: HTML
• Homepage:
• Size: 1.86 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Documentation

Web cá nhân.

## Các lệnh khi chạy

Tài liệu này sử dụng [MkDocs](https://www.mkdocs.org/) để thực hiện gen thành HTML từ cấu trúc file markdown.

Serve để preview website khi viết tài liệu

```

mkdocs serve

```

Build tài liệu thành site HTML tĩnh (thư mục sau khi build là `site`)

```

mkdocs build

```

Trường hợp chưa thể chạy các lệnh trên, bạn cần phải cài đặt python và các package qua pip:

1. Cài đặt [python và pip](https://www.python.org/downloads/)

2. Cài đặt mkdocs qua pip `pip install mkdocs`

3. Cài đặt thêm material theme `pip install mkdocs-material`

4. Cài đặt các ext của python `pip install pymdown-extensions`

Có thể đọc thêm tài liệu tại [MkDocs](https://www.mkdocs.org/) và [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)