乐山网站建设

专注高端品牌网站建设行业优质供应商！认准小谭建站！
028-86922220135-1821-9792
  • 首页
  • 网站建设
    网站设计包含服务 网站制作流程 有效沟通方式 售后服务
  • 微信开发
  • 案例展示
    乐山小谭建站公司作品案例展示
  • 新闻资讯
  • 解决方案
  • 小谭建站
  • 联系我们

    • 怎么使用Docsify和GitHubPages创建一个文档网站

    这篇文章主要介绍怎么使用Docsify和GitHub Pages创建一个文档网站，文中介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们一定要看完！

    创新互联公司-专业网站定制、快速模板网站建设、高性价比镶黄网站开发、企业建站全套包干低至880元,成熟完善的模板库,直接使用。一站式镶黄网站制作公司更省心,省钱,快速模板网站建设找我们，业务覆盖镶黄地区。费用合理售后完善，十多年实体公司更值得信赖。

    使用 Docsify 创建文档网页并发布到 GitHub Pages 上。

    文档是帮助用户使用开源项目一个重要部分，但它并不总是开发人员的首要任务，因为他们可能更关注的是使他们的应用程序更好，而不是帮助人们使用它。对开发者来说，这就是为什么让发布文档变得更容易是如此有价值的原因。在本教程中，我将向你展示一个这样做的方式：将 Docsify 文档生成器与 GitHub Pages 结合起来。

    默认情况下，GitHub Pages 会提示用户使用 Jekyll，这是一个支持 HTML、CSS 和其它网页技术的静态网站生成器。Jekyll 可以从以 Markdown 格式编码的文档文件中生成一个静态网站，GitHub 会自动识别它们的 .md 或 .markdown 扩展名。虽然这种设置很好，但我想尝试一下其他的东西。

    幸运的是，GitHub Pages 支持 HTML 文件，这意味着你可以使用其他网站生成工具（比如  Docsify）在这个平台上创建一个网站。Docsify 是一个采用 MIT 许可证的开源项目，其具有可以让你在 GitHub Pages  上轻松创建一个有吸引力的、先进的文档网站的功能。

    怎么使用Docsify和GitHub Pages创建一个文档网站

    Docsify

    开始使用 Docsify

    安装 Docsify 有两种方法：

    1. 鸿蒙官方战略合作共建——HarmonyOS技术社区

    2. 通过 NPM 安装 Docsify 的命令行界面（CLI）。

    3. 手动编写自己的 index.html。

    Docsify 推荐使用 NPM 方式，但我将使用第二种方案。如果你想使用 NPM，请按照快速入门指南中的说明进行操作。

    从 GitHub 下载示例内容

    我已经在该项目的 GitHub 页面上发布了这个例子的源代码。你可以单独下载这些文件，也可以通过以下方式克隆这个存储库。

    git clone https://github.com/bryantson/OpensourceDotComDemos

    然后 cd 进入 DocsifyDemo 目录。

    我将在下面为你介绍这些代码，它们克隆自我的示例存储库中，这样你就可以理解如何修改 Docsify。如果你愿意，你也可以从头开始创建一个新的 index.html 文件，就像 Docsify 文档中的的示例一样：

               
        

    探索 Docsify 如何工作

    如果你克隆了我的 GitHub 存储库，并切换到 DocsifyDemo 目录下，你应该看到这样的文件结构：

    怎么使用Docsify和GitHub Pages创建一个文档网站

    File contents in the cloned GitHub

    文件/文件夹名称内容
    index.html主要的 Docsify 初始化文件，也是最重要的文件
    _sidebar.md生成导航
    README.md你的文档根目录下的默认 Markdown 文件
    images包含了 README.md 中的示例 .jpg 图片
    其它目录和文件包含可导航的 Markdown 文件

    index.html 是 Docsify 可以工作的唯一要求。打开该文件，你可以查看其内容：

               Docsify Demo  
        

    这本质上只是一个普通的 HTML 文件，但看看这两行：

    ... 一些其它内容 ...

    这些行使用内容交付网络（CDN）的 URL 来提供 CSS 和 JavaScript 脚本，以将网站转化为 Docsify 网站。只要你包含这些行，你就可以把你的普通 GitHub 页面变成 Docsify 页面。

     标签后的第一行指定了要渲染的内容：

    Docsify 使用单页应用（SPA）的方式来渲染请求的页面，而不是刷新一个全新的页面。

    最后，看看 

    在这个块中：

    你可以在 Docsify 文档的配置部分找到所有选项。

    接下来，看看 _sidebar.md 文件。因为你在 index.html 中设置了 loadSidebar 属性值为 true，所以 Docsify 会查找 _sidebar.md 文件，并根据其内容生成导航文件。示例存储库中的 _sidebar.md 内容是：

      * [HOME](./) * [Tutorials](./tutorials/index)  * [Tomcat](./tutorials/tomcat/index)  * [Cloud](./tutorials/cloud/index)  * [Java](./tutorials/java/index) * [About](./about/index) * [Contact](./contact/index)

    这会使用 Markdown 的链接格式来创建导航。请注意 “Tomcat”、“Cloud” 和 “Java” 等链接是缩进的；这意味着它们被渲染为父链接下的子链接。

    像 README.md 和 images 这样的文件与存储库的结构有关，但所有其它 Markdown 文件都与你的 Docsify 网页有关。

    根据你的需求，随意修改你下载的文件。下一步，你将把这些文件添加到你的 GitHub 存储库中，启用 GitHub Pages，并完成项目。

    启用 GitHub 页面

    创建一个示例的 GitHub 存储库，然后使用以下 GitHub 命令检出、提交和推送你的代码：

    $ git clone 你的 GitHub 存储库位置$ cd 你的 GitHub 存储库位置$ git add .$ git commit -m "My first Docsify!"$ git push

    设置你的 GitHub Pages 页面。在你的新 GitHub 存储库中，点击 “Settings”：

    怎么使用Docsify和GitHub Pages创建一个文档网站

    Settings link in GitHub

    向下滚动直到看到 “GitHub Pages”：

    怎么使用Docsify和GitHub Pages创建一个文档网站

    GitHub Pages settings

    查找 “Source” 部分：

    怎么使用Docsify和GitHub Pages创建一个文档网站

    GitHub Pages settings

    点击 “Source” 下的下拉菜单。通常，你会将其设置为 “master branch”，但如果你愿意，也可以使用其他分支：

    怎么使用Docsify和GitHub Pages创建一个文档网站

    Setting Source to master branch

    就是这样！你现在应该有一个链接到你的 GitHub Pages 的页面了。点击该链接将带你到那里，然后用 Docsify 渲染：

    怎么使用Docsify和GitHub Pages创建一个文档网站

    Link to GitHub Pages docs site

    它应该像这样：

    怎么使用Docsify和GitHub Pages创建一个文档网站

    以上是“怎么使用Docsify和GitHub Pages创建一个文档网站”这篇文章的所有内容，感谢各位的阅读！希望分享的内容对大家有帮助，更多相关知识，欢迎关注创新互联行业资讯频道！


    新闻名称：怎么使用Docsify和GitHubPages创建一个文档网站
    网站地址：http://lszwz.com/article/jsjgig.html

    其他资讯

    售后响应及时

    7×24小时客服热线

    数据备份

    更安全、更高效、更稳定

    价格公道精准

    项目经理精准报价不弄虚作假

    合作无风险

    重合同讲信誉，无效全额退款

    联系我们

    TEL

    135-1821-9792

    028-86922220

    地址：乐山市太升南路288号锦天国际

    快捷导航

    Shortcut

    二维码

    QR CODE

    • 微信公众号

    • 手机端网站

    乐山小谭建站工作室是一家专注从事于高品质视觉体验及互联网设计开发，乐山网站建设，乐山网站设计，乐山网页设计，乐山网站制作，品牌网站建设，营销网站建设，集团网站建设，企业网站建设，外贸网站建设，响应式网站建设，小程序开发，微信开发，企业形象设计，企业宣传视频等服务，小谭建站位于乐山市龙岗区大运软件小镇，小谭建站拥有经验丰富的高级网站建设工程师和一流的网页高端设计人员，具备各种规模与类型网站建设的雄厚实力，在网站建设领域树立了自己独特的设计风格。
    友情链接 交换友情链接
    消防工程   ios开发   做网站的公司   seo关键词优化   梅州网站建设   电信机房托管服务器   蓬溪网站建设   响应式网站建设方案   成都网站建设   成都小程序   

    Copyright © 2022 青羊区小谭信息技术咨询服务工作室 乐山建站工作室 All Rights Reserved   蜀ICP备2021004003号-25

    Copyright © 2022 青羊区小谭信息技术咨询服务工作室 乐山建站工作室 

    蜀ICP备2021004003号-25