[PR #1018] [MERGED] docs: mkdocs and github pages support #927

New issue

Closed

opened 2026-02-25 23:35:55 +03:00 by kerem · 0 comments

kerem commented

2026-02-25 23:35:55 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/go-shiori/shiori/pull/1018
Author: @fmartingr
Created: 12/8/2024
Status: ✅ Merged
Merged: 12/8/2024
Merged by: @fmartingr

Base: master ← Head: refactor/docs-mkdocs

📝 Commits (10+)

12c727d refactor: Migrate documentation to MkDocs with material theme and improved structure
d2e3366 refactor: docs images hierarchy
3480803 refactor: Move screenshots to assets and update paths in Screenshots.md
ae1bf6d feat: Convert screenshots to MkDocs content tabs with light/dark theme switching
9cf803a feat: sync content tabs by label
47e9366 chore: add light theme with shiori red color
e54b4c8 docs: Update index page to match README with concise feature list
3101856 docs: Remove Resources section from documentation index
bbe81ea ci: added github workflows
cf01140 docs: Add section for building documentation in Contribute.md

📊 Changes

29 files changed (+191 additions, -153 deletions)

View changed files

➕ .github/workflows/_mkdocs-check.yml (+17 -0)
➕ .github/workflows/_mkdocs-publish.yml (+19 -0)
📝 .github/workflows/pull_request.yml (+3 -1)
📝 .github/workflows/version_bump.yml (+3 -0)
📝 .gitignore (+4 -0)
📝 docs/Contribute.md (+14 -0)
📝 docs/Screenshots.md (+67 -139)
➕ docs/assets/css/style.css (+3 -0)
📝 docs/assets/screenshots/01-login.png (+0 -0)
📝 docs/assets/screenshots/02-home.png (+0 -0)
📝 docs/assets/screenshots/03-home-list.png (+0 -0)
📝 docs/assets/screenshots/04-options.png (+0 -0)
📝 docs/assets/screenshots/05-dark-login.png (+0 -0)
📝 docs/assets/screenshots/06-dark-home.png (+0 -0)
📝 docs/assets/screenshots/07-dark-home-list.png (+0 -0)
📝 docs/assets/screenshots/08-dark-options.png (+0 -0)
📝 docs/assets/screenshots/09-mobile-login.png (+0 -0)
📝 docs/assets/screenshots/10-mobile-home.png (+0 -0)
📝 docs/assets/screenshots/11-mobile-home-list.png (+0 -0)
📝 docs/assets/screenshots/12-mobile-options.png (+0 -0)

...and 9 more files

📄 Description

Initial pull request adding mkdocs support to the documention.

Closes #703

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/go-shiori/shiori/pull/1018 **Author:** [@fmartingr](https://github.com/fmartingr) **Created:** 12/8/2024 **Status:** ✅ Merged **Merged:** 12/8/2024 **Merged by:** [@fmartingr](https://github.com/fmartingr) **Base:** `master` ← **Head:** `refactor/docs-mkdocs` --- ### 📝 Commits (10+) - [`12c727d`](https://github.com/go-shiori/shiori/commit/12c727de4e6d0ad8b9bc86d82de7660c7e2509ae) refactor: Migrate documentation to MkDocs with material theme and improved structure - [`d2e3366`](https://github.com/go-shiori/shiori/commit/d2e3366af591c1d31878fec8eafe5c0e2026faf3) refactor: docs images hierarchy - [`3480803`](https://github.com/go-shiori/shiori/commit/34808034802bda6a27b635c3d98f3995276f049b) refactor: Move screenshots to assets and update paths in Screenshots.md - [`ae1bf6d`](https://github.com/go-shiori/shiori/commit/ae1bf6da321b96ee8026710dc32cfc7b650067ed) feat: Convert screenshots to MkDocs content tabs with light/dark theme switching - [`9cf803a`](https://github.com/go-shiori/shiori/commit/9cf803a3d00a94df746fa44e791caf27cffc47ec) feat: sync content tabs by label - [`47e9366`](https://github.com/go-shiori/shiori/commit/47e9366233e0e05401ccd1c60e5a3a1d0372ed1b) chore: add light theme with shiori red color - [`e54b4c8`](https://github.com/go-shiori/shiori/commit/e54b4c86d7f4f7f826a0b41dc8848b303fec20ae) docs: Update index page to match README with concise feature list - [`3101856`](https://github.com/go-shiori/shiori/commit/31018567181456fcea1b79d92bd625930978857f) docs: Remove Resources section from documentation index - [`bbe81ea`](https://github.com/go-shiori/shiori/commit/bbe81ea531e249323660b14734b2a2fc3eecc4f6) ci: added github workflows - [`cf01140`](https://github.com/go-shiori/shiori/commit/cf011405af1e31fab9babb6a47faa897a4997892) docs: Add section for building documentation in Contribute.md ### 📊 Changes **29 files changed** (+191 additions, -153 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/_mkdocs-check.yml` (+17 -0) ➕ `.github/workflows/_mkdocs-publish.yml` (+19 -0) 📝 `.github/workflows/pull_request.yml` (+3 -1) 📝 `.github/workflows/version_bump.yml` (+3 -0) 📝 `.gitignore` (+4 -0) 📝 `docs/Contribute.md` (+14 -0) 📝 `docs/Screenshots.md` (+67 -139) ➕ `docs/assets/css/style.css` (+3 -0) 📝 `docs/assets/screenshots/01-login.png` (+0 -0) 📝 `docs/assets/screenshots/02-home.png` (+0 -0) 📝 `docs/assets/screenshots/03-home-list.png` (+0 -0) 📝 `docs/assets/screenshots/04-options.png` (+0 -0) 📝 `docs/assets/screenshots/05-dark-login.png` (+0 -0) 📝 `docs/assets/screenshots/06-dark-home.png` (+0 -0) 📝 `docs/assets/screenshots/07-dark-home-list.png` (+0 -0) 📝 `docs/assets/screenshots/08-dark-options.png` (+0 -0) 📝 `docs/assets/screenshots/09-mobile-login.png` (+0 -0) 📝 `docs/assets/screenshots/10-mobile-home.png` (+0 -0) 📝 `docs/assets/screenshots/11-mobile-home-list.png` (+0 -0) 📝 `docs/assets/screenshots/12-mobile-options.png` (+0 -0) _...and 9 more files_ </details> ### 📄 Description Initial pull request adding mkdocs support to the documention. Closes #703 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>