164 Star 224 Fork 1.2K

openGauss / docs

 / 详情

离线版的网页文档怎么获取?

已完成
咨询
创建于  
2024-05-14 17:15

内网开发需要网页版的手册,请问该怎么样获取?
我现在只有代码里面的.md文档,或者说用什么工具变成网页版?

评论 (3)

哇101 创建了咨询

Hey @哇101, Welcome to openGauss Community.
All of the projects in openGauss Community are maintained by @opengauss_bot.
That means the developers can comment below every pull request or issue to trigger Bot Commands.
Please follow instructions at Here to find the details.

opengauss_bot 添加了
 
sig/docs
标签

Hi @哇101,
if you want to get quick review about your issue, please contact the owner in first: @liyang ,
and then any of the maintainers: @kangyang , @舛扬
and then any of the committers: @Freyaqqianjin , @刘贵宾 , @jiangxiaoying , @樊雅清 , @guohuan , @Kamus , @liuxu-enmo , @lestertt , @liyang , @tongdabao , @李轶楠 , @sky-stars , @zhang cuiping , @mentoswang
if you have any question, please contact the SIG: Docs.

哇101 修改了标题
哇101 修改了描述
王恬静 负责人设置为tongdabao
王恬静 添加协作者舛扬
王恬静 优先级设置为不重要
  1. 使用静态站点生成器
    静态站点生成器可以将 Markdown 文件转换为静态的 HTML 文件,你可以轻松地部署到内网服务器上。以下是一些常用的静态站点生成器:
    Jekyll:这是一个流行的 Ruby 静态站点生成器,它支持 Markdown,并有很多主题和插件可以选择。
    Hugo:Hugo 是一个用 Go 编写的快速且灵活的静态站点生成器。
    Hexo:Hexo 是一个基于 Node.js 的静态博客框架,可以轻松地将 Markdown 文件渲染成网页。
  2. 使用在线转换工具
    如果你不想设置静态站点生成器,你可以使用在线的 Markdown 到 HTML 转换工具。这些工具允许你上传 Markdown 文件,然后下载生成的 HTML 文件。但是请注意,这种方法可能不适合大型项目或需要频繁更新的文档,因为它通常不支持版本控制或自动化构建。
  3. 编写简单的 HTML/CSS/JS
    如果你有基本的网页开发知识,你可以编写一个简单的 HTML 页面,通过 CSS 和 JavaScript 来加载和显示 Markdown 文件。但是,这通常需要处理 Markdown 的解析和渲染,可能需要使用 JavaScript 库(如 Markdown-it 或 Showdown)来帮助完成这个任务。
  4. 使用 GitBook 或类似的工具
    GitBook 是一个基于 Git 的文档平台,它允许你使用 Markdown 来编写文档,并提供了一个内置的服务器来发布这些文档。GitBook 还支持版本控制、搜索、注释等功能。然而,它可能需要一些配置才能在内网中使用。
  5. 使用 Markdown 预览工具
    一些文本编辑器或 IDE(如 Visual Studio Code、Typora 等)内置了 Markdown 预览功能,可以在本地直接查看 Markdown 文件的渲染效果。虽然这不是一个完整的网页版手册解决方案,但它可能对于个人或小型团队来说是一个简单而快速的选择。
  6. 部署到 GitHub Pages 或其他云服务平台
    如果你愿意将文档公开到互联网上(即使只是在内网中共享),你可以使用 GitHub Pages 或其他云服务平台(如 Netlify、Vercel 等)来托管你的静态站点。这些平台通常提供了免费的托管选项,并支持自定义域名和 SSL 证书。
  7. 使用 Docker 容器
    你还可以考虑使用 Docker 来创建一个包含静态站点生成器和 Markdown 文件的容器,并在内网服务器上运行这个容器。这种方法可以确保你的文档环境是可移植和可重复的。
tongdabao 任务状态待办的 修改为已答复
mentoswang 任务状态已答复 修改为已完成

登录 后才可以发表评论

状态
负责人
项目
里程碑
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
预计工期 (小时)
参与者(4)
13084139 opengauss bot 1686829535 8334568 zijianli16 1605736055
1
https://gitee.com/opengauss/docs.git
git@gitee.com:opengauss/docs.git
opengauss
docs
docs

搜索帮助