欢迎来到文档导航项目!这是一个精心设计的静态网页解决方案,旨在帮助用户轻松浏览和管理各种在线文档。
本项目基于静态网页技术,可轻松部署至各类支持静态托管的服务平台,如GitHub Pages
、Netlify
等。
如何部署:
-
fork
到个人仓库 -
设置仓库的
setting
中GitHub pages
,选择main
分支并save
保存 -
在个人仓库的
action
里,可以看到部署好的项目对应域名
支持docker部署,最后一次docker提交参考
docker pull lmliheng/lihe-document:1.0
使用mkdocs
进行构建
环境python3.8 + pip安装mkdocs
我们热忱期待您的参与!欲为项目添砖加瓦,请按以下流程操作:
📋 在GitHub上创建Issue
,清晰描述您欲解决的问题或提议的新功能。
📝 撰写并保存Markdown
格式的贡献文档(.md),详述您的改动,并将其置于contributions
目录下。
📤 发起Pull Request
,以便我们将您的贡献整合入主项目。
我们将迅速审核您的贡献,一经通过,即刻纳入项目。
若您有疑问或建议,欢迎通过以下方式联系我们:
本项目遵循Apache License
进行授权,详情请参阅LICENSE
文件。