Skip to content
This repository has been archived by the owner on Jan 18, 2025. It is now read-only.

Commit

Permalink
docs: use snippets instead of markdown include plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinNitroG committed Jan 13, 2025
1 parent 2b9aa66 commit 3a21248
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 73 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/config.json
/schemas
/schemas_site
/mkdocs-include-markdown-cache
/.cache

# Created by https://www.toptal.com/developers/gitignore/api/python,venv
Expand Down
4 changes: 1 addition & 3 deletions docs/dev/checkphatnguoi_vn.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# checkphatnguoi.vn

```http
{%
include "../../requests/checkphatnguoi_vn.http"
%}
--8<-- "requests/checkphatnguoi_vn.http"
```

## Curl
Expand Down
4 changes: 1 addition & 3 deletions docs/dev/csgt_vn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# csgt.vn

```http
{%
include "../../requests/csgt_vn.http"
%}
--8<-- "requests/csgt_vn.http"
```
4 changes: 1 addition & 3 deletions docs/dev/phatnguoi_vn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# phatnguoi.vn

```http
{%
include "../../requests/phatnguoi_vn.http"
%}
--8<-- "requests/phatnguoi_vn.http"
```
13 changes: 7 additions & 6 deletions docs/usage/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@

Project được viết bằng python 3.13 nhưng có thể chạy với python 3.10 trở lên (không đảm bảo). Đối với discord notification yêu cầu phiên bản >= 3.13.

???+ warning

- Hiện tại API từ csgt.vn không đảm bảo hoạt động.
- checkphatnguoi.vn không cho truy cập từ IP nước ngoài? (Ảnh hưởng github action)

---

## Clone repo
Expand Down Expand Up @@ -72,16 +77,12 @@ Thiết lập file `config.json` (1)
??? example

```json title="config.json"
{% include "../../config.sample.json" %}
--8<-- "config.sample.json"
```

???+ note

Xem [`Config Schema`](https://ntgnguyen.github.io/check-phat-nguoi/schemas/config.html) để biết chi tiết config

???+ warning

Hiện tại API từ csgt.vn không đảm bảo hoạt động.
Xem [Config Schema](https://ntgnguyen.github.io/check-phat-nguoi/schemas/config.html) để biết chi tiết config

### Chạy chương trình

Expand Down
2 changes: 0 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,6 @@ plugins:
- stemmer
- stopWordFilter
- trimmer
- include-markdown:
cache_dir: ./mkdocs-include-markdown-cache

nav:
- 'Trang chủ':
Expand Down
6 changes: 1 addition & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,4 @@ build-backend = "hatchling.build"

[dependency-groups]
dev = ["pre-commit>=4.0.1"]
build-website = [
"json-schema-for-humans>=1.3.4",
"mkdocs-material>=9.5.49",
"mkdocs-include-markdown-plugin[cache]>=7.1.2",
]
build-website = ["json-schema-for-humans>=1.3.4", "mkdocs-material>=9.5.49"]
9 changes: 0 additions & 9 deletions requirements/requirements-build-website.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
babel==2.16.0 \
--hash=sha256:368b5b98b37c06b7daf6696391c3240c938b37767d4584413e8438c5c435fa8b \
--hash=sha256:d1f3554ca26605fe173f3de0c65f750f5a42f924499bf134de6423582298e316
bracex==2.5.post1 \
--hash=sha256:12c50952415bfa773d2d9ccb8e79651b8cdb1f31a42f6091b804f6ba2b4a66b6 \
--hash=sha256:13e5732fec27828d6af308628285ad358047cec36801598368cb28bc631dbaf6
certifi==2024.12.14 \
--hash=sha256:1275f7a45be9464efc1173084eaa30f866fe2e47d389406136d332ed4967ec56 \
--hash=sha256:b650d30f370c2b724812bee08008be0c4163b163ddaec3f2546c1caf65f191db
Expand Down Expand Up @@ -155,9 +152,6 @@ mkdocs==1.6.1 \
mkdocs-get-deps==0.2.0 \
--hash=sha256:162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c \
--hash=sha256:2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134
mkdocs-include-markdown-plugin==7.1.2 \
--hash=sha256:1b393157b1aa231b0e6c59ba80f52b723f4b7827bb7a1264b505334f8542aaf1 \
--hash=sha256:ff1175d1b4f83dea6a38e200d6f0c3db10308975bf60c197d31172671753dbc4
mkdocs-material==9.5.49 \
--hash=sha256:3671bb282b4f53a1c72e08adbe04d2481a98f85fed392530051f80ff94a9621d \
--hash=sha256:c3c2d8176b18198435d3a3e119011922f3e11424074645c24019c2dcf08a360e
Expand Down Expand Up @@ -336,6 +330,3 @@ watchdog==6.0.0 \
--hash=sha256:d1cdb490583ebd691c012b3d6dae011000fe42edb7a82ece80965b42abd61f26 \
--hash=sha256:e3df4cbb9a450c6d49318f6d14f4bbc80d763fa587ba46ec86f99f9e6876bb26 \
--hash=sha256:ef810fbf7b781a5a593894e4f439773830bdecb885e6880d957d5b9382a960d2
wcmatch==10.0 \
--hash=sha256:0dd927072d03c0a6527a20d2e6ad5ba8d0380e60870c383bc533b71744df7b7a \
--hash=sha256:e72f0de09bba6a04e0de70937b0cf06e55f36f37b3deb422dfaf854b867b840a
41 changes: 0 additions & 41 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3a21248

Please sign in to comment.