时间:2023-05-07 11:01:55 点击次数:26
Docsite 是一款集官网、文档、博客和社区为一体的静态开源站点的解决方案,具有简单易上手、上手不撒手的特质,同时支持 react 和静态渲染、PC 端和移动端、支持中英文国际化、SEO、markdown 文档、全局站点搜索、站点风格自定义、页面自定义等功能。
目前github star 835, 官网截图如下:
安装
docsite 用于根据markdown文档快速搭建静态站点。
确保安装的node的版本满足如下要求:node >= 6.9.0执行npm install docsite -g执行全局安装验证安装
在终端中执行docsite -V,能够显示当前安装的docsite版本,则表示安装成功。
站点准备
在成功安装完docsite之后,进入项目根目录,执行docsite init
现在网站的骨架搭建完成,可以进行网站的自定义和内容填充了。
创建站点
在项目根目录下执行docsite start命令,会在浏览器中自动打开页面。
初始化生成的模板工程默认集成了首页、文档页、博客列表页、博客详情页、社区页及中英文国际化功能。可以按照需求自行添加和删除页面。
添加文档
将对应的.md或者.markdown文件放进docs文件夹下的对应语言目录中,支持多级目录在site_config文件夹下的docs.js中配置文档的菜单项添加博客
将对应的.md或者.markdown文件放进blog文件夹下的对应语言目录中,支持多级目录存放在site_config文件夹下的blog.js中配置博客的列表项发布站点
首先,需要配置下站点的根路径,修改site_config/site.js中的rootPath字段。规则如下:
当部署根路径为/,则设置为空字符串即可。当部署根路径不为/,则设置为具体的根路径,注意需以/开头,但不能有尾/。至此,整个站点的开发已经完成,在项目根目录下执行docsite build进行项目构建。
站点托管
你可以将站点托管在github pages上或者自己的服务器上。
如需更详细介绍,请查阅官方文档。