{"id":15020261,"url":"https://github.com/xinetzone/mystx","last_synced_at":"2026-02-16T13:09:13.808Z","repository":{"id":130622649,"uuid":"468965745","full_name":"xinetzone/xyzstyle","owner":"xinetzone","description":"Generic knowledge base template.","archived":false,"fork":false,"pushed_at":"2025-01-04T01:24:34.000Z","size":69,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-31T06:51:20.854Z","etag":null,"topics":["book","d2py","deep-learning","jupyter-notebook","python","sphinx","sphinx-theme","xyzstyle"],"latest_commit_sha":null,"homepage":"https://xinetzone.github.io/xyzstyle/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xinetzone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-12T03:13:01.000Z","updated_at":"2025-01-04T01:24:37.000Z","dependencies_parsed_at":"2024-03-08T03:22:15.186Z","dependency_job_id":"213343e4-aebb-4484-ae47-1a736f00f445","html_url":"https://github.com/xinetzone/xyzstyle","commit_stats":{"total_commits":86,"total_committers":3,"mean_commits":"28.666666666666668","dds":0.4418604651162791,"last_synced_commit":"4a4e49ab2e5d74c02daf16f455c15cdfa7d222f0"},"previous_names":[],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xinetzone%2Fxyzstyle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xinetzone%2Fxyzstyle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xinetzone%2Fxyzstyle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xinetzone%2Fxyzstyle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xinetzone","download_url":"https://codeload.github.com/xinetzone/xyzstyle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238120391,"owners_count":19419763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["book","d2py","deep-learning","jupyter-notebook","python","sphinx","sphinx-theme","xyzstyle"],"created_at":"2024-09-24T19:54:49.206Z","updated_at":"2025-10-25T10:30:59.030Z","avatar_url":"https://github.com/xinetzone.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MySTX\n\n![repo size](https://img.shields.io/github/repo-size/xinetzone/mystx.svg)\n[![PyPI][pypi-badge]][pypi-link]\n[![GitHub issues][issue-badge]][issue-link]\n[![GitHub forks][fork-badge]][fork-link]\n[![GitHub stars][star-badge]][star-link]\n[![GitHub license][license-badge]][license-link]\n[![contributors][contributor-badge]][contributor-link]\n[![Documentation Status][status-badge]][status-link]\n[![Downloads][download-badge]][download-link]\n[![PyPI - Downloads][install-badge]][install-link]\n\n[pypi-badge]: https://img.shields.io/pypi/v/mystx.svg\n[pypi-link]: https://pypi.org/project/mystx/\n[issue-badge]: https://img.shields.io/github/issues/xinetzone/mystx\n[issue-link]: https://github.com/xinetzone/mystx/issues\n[fork-badge]: https://img.shields.io/github/forks/xinetzone/mystx\n[fork-link]: https://github.com/xinetzone/mystx/network\n[star-badge]: https://img.shields.io/github/stars/xinetzone/mystx\n[star-link]: https://github.com/xinetzone/mystx/stargazers\n[license-badge]: https://img.shields.io/github/license/xinetzone/mystx\n[license-link]: https://github.com/xinetzone/mystx/LICENSE\n[contributor-badge]: https://img.shields.io/github/contributors/xinetzone/mystx\n[contributor-link]: https://github.com/xinetzone/mystx/contributors\n[status-badge]: https://readthedocs.org/projects/mystx/badge/?version=latest\n[status-link]: https://mystx.readthedocs.io/zh-cn/latest/?badge=latest\n[download-badge]: https://pepy.tech/badge/mystx\n[download-link]: https://pepy.tech/project/mystx\n[install-badge]: https://img.shields.io/pypi/dw/mystx?label=pypi%20installs\n[install-link]: https://pypistats.org/packages/mystx\n\n**MySTX** 是基于 Sphinx Book Theme 的现代化、可定制的 Sphinx HTML 主题，为技术文档提供优雅美观的展示效果。它结合了现代Web设计理念与优秀的阅读体验，使您的文档既专业又易于阅读。\n\n## ✨ 特性\n\n- 🎨 基于 Sphinx Book Theme 的现代化设计风格\n- 🛠️ 灵活的主题配置系统，支持从 TOML 文件加载主题配置选项\n- 📝 完善的 MyST Markdown 和 Jupyter Notebook 支持\n- 🚀 简单易用的主题注册和配置应用流程\n- 📚 丰富的可选扩展，用于增强文档功能\n\n## 🔧 安装\n\n### 基本安装\n\n使用 pip 安装 mystx 主题：\n\n```bash\npip install mystx\n```\n\n### 安装文档扩展\n\n如果需要使用文档扩展功能，可以安装可选依赖：\n\n```bash\npip install \"mystx[doc]\"\n```\n\n### 开发环境安装\n\n对于开发者，可以安装开发依赖：\n\n```bash\npip install -ve .[dev]\n```\n\n## 📋 依赖\n\n### 核心依赖\n\n- `sphinx-book-theme\u003e=1.1.4` (主题继承)\n- `sphinx\u003e=8.0.0` (文档生成引擎)\n- `myst-nb` (Jupyter Notebook 支持)\n- `myst-parser` (MyST Markdown 解析器)\n- Python 3.12+ (运行环境)\n\n## 🚀 快速开始\n\n在您的 Sphinx 项目的 `conf.py` 文件中，添加以下配置来使用 `mystx` 主题：\n\n```python\n# conf.py\nproject = \"mystx 文档\" # 文档项目名称\nauthor = \"xinetzone\" # 文档作者\n# == 国际化与本地化设置 ==================================================================\nlanguage = 'zh_CN' # 文档语言（中文简体）\nlocale_dirs = ['../locales/'] # 翻译文件存放目录\ngettext_compact = False # 是否合并子目录的PO文件（False表示不合并）\n# 插件\nextensions = ['mystx']\nhtml_last_updated_fmt = '%Y-%m-%d, %H:%M:%S'  # 文档的最后更新时间格式\n# 排除文件和目录模式\nexclude_patterns = [\n    \"_build\",  # 构建输出目录\n    \"Thumbs.db\",  # 缩略图数据库\n    \".DS_Store\",  # macOS 系统文件\n]\nstatic_path = [\"_static\"]  # 静态资源目录，用于存放CSS、JavaScript、图片等\nhtml_theme = 'mystx'  # 使用的主题名称\nhtml_logo = \"_static/images/logo.jpg\" # 文档logo\nhtml_title = \"Sphinx mystx Theme\" # 文档标题\nhtml_copy_source = True # 是否在文档中包含源文件链接\nhtml_favicon = \"_static/images/favicon.jpg\" # 文档favicon\n```\n\n## ⚙️ 配置指南\n\nmystx 主题提供了丰富的配置选项，让您可以根据项目需求自定义文档外观和功能。以下是配置指南：\n\n### 主题选项\n\nmystx 主题支持通过两种方式配置主题选项：\n\n#### 方式一：在 `conf.py` 文件中配置\n\n在 Sphinx 项目的 `conf.py` 文件中，使用 `html_theme_options` 字典配置各种主题选项：\n\n```python\nhtml_theme_options = {\n    # 仓库相关配置\n    \"repository_url\": \"https://github.com/yourusername/yourproject\",  # 项目仓库地址\n    \"use_repository_button\": True,  # 在页眉显示指向存储库的小 GitHub 徽标\n    \"use_issues_button\": True,  # 是否显示问题反馈按钮\n    \"use_edit_page_button\": True,  # 是否显示编辑页面按钮\n    \"path_to_docs\": \"doc/\",  # 文档目录（相对于项目根目录）\n    \n    # 导航相关配置\n    \"home_page_in_toc\": false,  # 是否在目录中显示首页\n    \"show_navbar_depth\": 2,  # 导航栏显示的层级深度\n    \n    # 其他配置\n}\n```\n\n#### 方式二：通过 `_config.toml` 文件配置\n\n您也可以在项目根目录创建 `_config.toml` 文件，使用 TOML 格式配置主题选项：\n\n```toml\n[html_theme_options]\n# 仓库相关配置\nrepository_url = \"https://github.com/yourusername/yourproject\"\nuse_repository_button = true\nuse_issues_button = true\nuse_edit_page_button = true\npath_to_docs = \"doc/\" # 文档目录（相对于项目根目录）\n\n# 导航相关配置\nhome_page_in_toc = false # 是否在目录中显示首页\nshow_navbar_depth = 2 # 导航栏显示的层级深度\n\n# 其他配置\n```\n\n您可以根据实际需求选择性配置上述选项，未配置的选项将使用默认值。\n\n## 📚 文档\n\n请访问 [mystx 官方文档](https://mystx.readthedocs.io/zh-cn/latest/) 以及 [daobook/sphinx-book-theme](https://github.com/daobook/sphinx-book-theme)的[Sphinx Book Theme 文档](https://daobook.github.io/sphinx-book-theme/) 了解更多详细信息和使用示例。\n\n## 🔗 链接\n\n- [GitHub 仓库](https://github.com/xinetzone/mystx)\n- [PyPI 项目页面](https://pypi.org/project/mystx/)\n- [官方文档](https://mystx.readthedocs.io/)\n- [问题反馈](https://github.com/xinetzone/mystx/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxinetzone%2Fmystx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxinetzone%2Fmystx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxinetzone%2Fmystx/lists"}