Skip to content

lmliheng/document

Repository files navigation

🚀 文档导航系统 🚀

欢迎来到文档导航项目!这是一个精心设计的静态网页解决方案,旨在帮助用户轻松浏览和管理各种在线文档。

🌐 在线访问

访问原网站或者访问GitHub pages网站

💻 部署指南

本项目基于静态网页技术,可轻松部署至各类支持静态托管的服务平台,如GitHub PagesNetlify等。

如何部署:

  1. fork到个人仓库

  2. 设置仓库的settingGitHub pages,选择main分支并save保存

  3. 在个人仓库的action里,可以看到部署好的项目对应域名

支持docker部署,最后一次docker提交参考

docker pull lmliheng/lihe-document:1.0

底层

使用mkdocs进行构建

环境python3.8 + pip安装mkdocs

🤝 贡献指南

我们热忱期待您的参与!欲为项目添砖加瓦,请按以下流程操作:

📋 在GitHub上创建Issue,清晰描述您欲解决的问题或提议的新功能。

📝 撰写并保存Markdown格式的贡献文档(.md),详述您的改动,并将其置于contributions目录下。

📤 发起Pull Request,以便我们将您的贡献整合入主项目。

我们将迅速审核您的贡献,一经通过,即刻纳入项目。

📧 联系方式

若您有疑问或建议,欢迎通过以下方式联系我们:

邮箱:[email protected]

📄 许可声明

本项目遵循Apache License进行授权,详情请参阅LICENSE文件。

About

Document navigation code stir fry

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages