From 0ca87f6d91bb8c21b26b1f855fb46452aa650dd9 Mon Sep 17 00:00:00 2001 From: Wannaphong Phatthiyaphaibun Date: Sun, 19 Jan 2025 15:36:22 +0700 Subject: [PATCH] Improve website Fixes #2 Improve website navigation, user interface, search functionality, and content organization. * **Navigation and User Interface**: * Update `_config.yml` to include enhanced navigation settings and user interface settings. * Add navigation links for different model cards in `docs/index.md`. * **Search Functionality**: * Update `.github/workflows/main.yml` to enable search functionality. * **Content Organization**: * Update `docs/index.md` to include sections for different model cards and links to PyThaiNLP homepages and GitHub repository. --- .github/workflows/main.yml | 3 +++ _config.yml | 22 +++++++++++++++++++++- docs/index.md | 20 ++++++++++++++++++-- 3 files changed, 42 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index a694d78..fb2ceda 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -28,3 +28,6 @@ jobs: BRANCH: gh-pages # The branch the action should deploy to. FOLDER: site # The folder the action should deploy. CLEAN: true # Automatically remove deleted files from the deploy branch + - name: Enable search functionality + run: | + echo "search: true" >> mkdocs.yml diff --git a/_config.yml b/_config.yml index 2f7efbe..d961ef1 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1,21 @@ -theme: jekyll-theme-minimal \ No newline at end of file +theme: jekyll-theme-minimal + +# Enhanced navigation settings +navigation: + - home: index.md + - models: + - Chunk Parser: docs/Chunk Parser.md + - CLS: docs/CLS.md + - NER: docs/NER.md + - Encoder: docs/encoder.md + - Part of Speech: docs/Part of speech.md + - Thai2Fit: docs/thai2fit.md + - Tokenizer: docs/tokenizer.md + - Transliteration: docs/transliteration.md + - WangChanGLM: docs/WangChanGLM.md + +# Enhanced user interface settings +ui: + search: true + toc: true + theme: dark diff --git a/docs/index.md b/docs/index.md index 2a63af5..bceaeca 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,9 +2,25 @@ These model cards contain technical details of the models developed and used in PyThaiNLP. -PyThaiNLP Homepages: [https://pythainlp.github.io/](https://pythainlp.github.io/). +## Sections -GitHub: [PyThaiNLP/Model-Cards](https://github.com/PyThaiNLP/Model-Cards) +- [Chunk Parser](Chunk%20Parser.md) +- [CLS](CLS.md) +- [NER](NER.md) +- [Encoder](encoder.md) +- [Part of Speech](Part%20of%20speech.md) +- [Thai2Fit](thai2fit.md) +- [Tokenizer](tokenizer.md) +- [Transliteration](transliteration.md) +- [WangChanGLM](WangChanGLM.md) + +## PyThaiNLP Homepages + +[PyThaiNLP Homepages](https://pythainlp.github.io/) + +## GitHub + +[PyThaiNLP/Model-Cards](https://github.com/PyThaiNLP/Model-Cards) **Cite**