=======
Shadocs
=======
.. image:: https://img.shields.io/pypi/v/shadocs.svg
:target: https://pypi.python.org/pypi/shadocs
.. image:: https://img.shields.io/travis/llango/shadocs.svg
:target: https://travis-ci.com/llango/shadocs
.. image:: https://readthedocs.org/projects/shadocs/badge/?version=latest
:target: https://shadocs.readthedocs.io/en/latest/?version=latest
:alt: 文档状态
Shadocs 一个清新美丽的mkdocs 主题。
* 开源协议: MIT license
* 文档: https://shadocs.readthedocs.io.
特征
--------
* ` pip install shadocs ` 进行安装便可。
* 修改mkdocs.yml 文件theme: name: 设置为 shadocs 便可。
鸣谢
-------
该包使用了 Cookiecutter_ 和 `llango/cookiecutter-shapackage`_ 模板创建。
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`llango/cookiecutter-shapackage`: https://github.com/llango/cookiecutter-shapackage
效果图
--------
.. image:: ./screen/jietu.png
:alt: 主题效果图
=======
历史
=======
1.0.1(202-04-26)
1. 修改code中的代码太长的换行问题。
1.0.0(2022-04-20)
1. 修改logo不一样的问题;
2. 更改页面链接主题颜色;
3. 修复了一些不明显的bug。
0.1.3(2022-04-15)
------------------
1. 修复侧边导航;
2. 添加新的logo;
3. 修改新的配色;
4. 对响应式修改一些基本的bugs。
* 修改搜索页面。
0.1.0 (2021-03-21)
------------------
* 在 PyPI 首个版本
0.1.1 (2021-03-22)
0.1.2 (2022-01-11)
1. 修改部分样式。
2. 添加了路径操作。
3. 修复部分bug。
Raw data
{
"_id": null,
"home_page": "https://github.com/llango/shadocs",
"name": "shadocs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "shadocs",
"author": "Rontom ai",
"author_email": "rontomai@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/94/ec/04b7f01d80150d5e5e8188c84586a8cc1344c66f07df4c9f5e0748d9be32/shadocs-1.0.3.tar.gz",
"platform": null,
"description": "=======\nShadocs\n=======\n\n\n.. image:: https://img.shields.io/pypi/v/shadocs.svg\n :target: https://pypi.python.org/pypi/shadocs\n\n.. image:: https://img.shields.io/travis/llango/shadocs.svg\n :target: https://travis-ci.com/llango/shadocs\n\n.. image:: https://readthedocs.org/projects/shadocs/badge/?version=latest\n :target: https://shadocs.readthedocs.io/en/latest/?version=latest\n :alt: \u6587\u6863\u72b6\u6001\n\n\n\n\nShadocs \u4e00\u4e2a\u6e05\u65b0\u7f8e\u4e3d\u7684mkdocs \u4e3b\u9898\u3002\n\n\n* \u5f00\u6e90\u534f\u8bae: MIT license\n* \u6587\u6863: https://shadocs.readthedocs.io.\n\n\n\u7279\u5f81\n--------\n\n* ` pip install shadocs ` \u8fdb\u884c\u5b89\u88c5\u4fbf\u53ef\u3002\n* \u4fee\u6539mkdocs.yml \u6587\u4ef6theme: name: \u8bbe\u7f6e\u4e3a shadocs \u4fbf\u53ef\u3002\n\n\u9e23\u8c22\n-------\n\n\u8be5\u5305\u4f7f\u7528\u4e86 Cookiecutter_ \u548c `llango/cookiecutter-shapackage`_ \u6a21\u677f\u521b\u5efa\u3002\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`llango/cookiecutter-shapackage`: https://github.com/llango/cookiecutter-shapackage\n\n\u6548\u679c\u56fe\n--------\n\n.. image:: ./screen/jietu.png\n :alt: \u4e3b\u9898\u6548\u679c\u56fe\n\n=======\n\u5386\u53f2\n=======\n1.0.1(202-04-26)\n1. \u4fee\u6539code\u4e2d\u7684\u4ee3\u7801\u592a\u957f\u7684\u6362\u884c\u95ee\u9898\u3002\n\n1.0.0(2022-04-20)\n1. \u4fee\u6539logo\u4e0d\u4e00\u6837\u7684\u95ee\u9898\uff1b\n2. \u66f4\u6539\u9875\u9762\u94fe\u63a5\u4e3b\u9898\u989c\u8272\uff1b\n3. \u4fee\u590d\u4e86\u4e00\u4e9b\u4e0d\u660e\u663e\u7684bug\u3002\n\n\n0.1.3(2022-04-15)\n------------------\n\n1. \u4fee\u590d\u4fa7\u8fb9\u5bfc\u822a;\n2. \u6dfb\u52a0\u65b0\u7684logo;\n3. \u4fee\u6539\u65b0\u7684\u914d\u8272;\n4. \u5bf9\u54cd\u5e94\u5f0f\u4fee\u6539\u4e00\u4e9b\u57fa\u672c\u7684bugs\u3002\n\n* \u4fee\u6539\u641c\u7d22\u9875\u9762\u3002\n\n\n0.1.0 (2021-03-21)\n------------------\n\n* \u5728 PyPI \u9996\u4e2a\u7248\u672c\n\n0.1.1 (2021-03-22)\n\n0.1.2 (2022-01-11)\n1. \u4fee\u6539\u90e8\u5206\u6837\u5f0f\u3002\n2. \u6dfb\u52a0\u4e86\u8def\u5f84\u64cd\u4f5c\u3002\n3. \u4fee\u590d\u90e8\u5206bug\u3002\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Cookiecutter ShaPackage \u5305\u542b\u521b\u5efaPython\u5305\u6240\u9700\u7684\u6240\u6709\u6a21\u677f\u6587\u4ef6\u3002",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/llango/shadocs"
},
"split_keywords": [
"shadocs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab8b8906e01e0f5d34e3bc302708da3b68c992c43f515e713c6e7938bc27b879",
"md5": "1826d35697832118701cc736861136cc",
"sha256": "b5ca4e0a5c9383461ae525ee0528fc2859d07fcd1262020841eec15cd9dafa4d"
},
"downloads": -1,
"filename": "shadocs-1.0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1826d35697832118701cc736861136cc",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.5",
"size": 394215,
"upload_time": "2023-09-08T05:07:15",
"upload_time_iso_8601": "2023-09-08T05:07:15.031723Z",
"url": "https://files.pythonhosted.org/packages/ab/8b/8906e01e0f5d34e3bc302708da3b68c992c43f515e713c6e7938bc27b879/shadocs-1.0.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94ec04b7f01d80150d5e5e8188c84586a8cc1344c66f07df4c9f5e0748d9be32",
"md5": "013b73622a78f9f00defb6ba18954094",
"sha256": "2086e199438b0dbbe0485457ae2d3ce27b0bcd9a77fd023c45fdd37018509f2e"
},
"downloads": -1,
"filename": "shadocs-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "013b73622a78f9f00defb6ba18954094",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 694016,
"upload_time": "2023-09-08T05:07:19",
"upload_time_iso_8601": "2023-09-08T05:07:19.657750Z",
"url": "https://files.pythonhosted.org/packages/94/ec/04b7f01d80150d5e5e8188c84586a8cc1344c66f07df4c9f5e0748d9be32/shadocs-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-08 05:07:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "llango",
"github_project": "shadocs",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "shadocs"
}