如何使用docsify和GitHub页面创建一个文档网站?
如何创建一个网站吗?文档是一个帮助用户使用开源项目的重要组成部分但它并不总是开发人员的首要任务因为他们可能更关心如何使他们的应用程序使用它更好。这就是为什么开发人员可以更轻松地发布文档。在本教程中seo资源因为他们可能更关心如何使他们的应用程序使用它更好。这就是为什么开发人员可以更轻松地发布文档。在本教程中我将向您展示一个方法:如何创建一个自己的网站。
如何使用docsify和GitHub页面创建一个文档网站?
在默认情况下githubpages将提示用户使用变身怪医一个静态网站生成器支持HTML CSS和其他web技术。变身怪医可以从文档生成一个静态网站文件编码以减少价格和GitHub会自动识别它们。医学博士。降价扩大。这是一个很好的环境但是我想尝试别的东西。
幸运的是githubpages支持HTML文件这意味着您可以使用其他网站生成工具如docsify这个平台上创建一个网站。Docsify与MIT许可是一个开放源代码项目它可以轻松地创建一个有吸引力的网站githubpages * * *文档。
文件有两种方法来安装docsify:
docsify建议NPM但我将使用第二个选项。如果你想使用NPM按照说明快速入门指南。
我发表了这个例子的源代码项目GitHub的页面。你可以单独下载这些文件或者在以下方面克隆存储库。
然后CD进入docsifydemo目录。
如果你克隆我的GitHub库和切换到docsifydemo目录您应该能看到以下文件结构:
文件的内容包含在ClonedWithub
这是基本上只是一个普通的HTML文件但看看这两条线:
这些线使用内容分发网络(CDN) url提供CSS和JavaScript脚本转换网站docsify站点。只要这些线包括常规GitHub页面可以被转换成一个文档页面。后的* * *线
body标签指定内容呈现:
Docsify使用一个单页面应用程序(SPA)呈现请求的页面而不是刷新新页面。
* * *看脚本块的行:在这个块
:
你可以找到所有的选项的配置节docsify文档。
它使用减价的链接格式创建导航。注意链接如tomcat云和Java是缩进;这意味着它们呈现为孩子父母下链接的链接。
形象README。医学相关文件和图像存储库的结构但所有其他减价文件docsify相关网页。
根据您的需要请修改您下载的文件。接下来将这些文件添加到GitHub库使githubpages并完成项目。
创建一个示例GitHub库并使用GitHub命令来查看后提交并推动代码:
设置githubpages页面。在新的GitHub库点击“设置”:
子
设置联系向下滚动直到你看到githubpages:
githubpages设置“发现”部分:
githubpages设置点击“源下的下拉菜单。通常你会把它作为“主分支”但您可以使用如果你想要其他分支:
设置SourceToMasterBranch
就是这样!现在应该有一个页面链接到githubpages。点击这个链接将带你去那儿然后使用docsify礼物:SubpagesDocssite
链接应该是这样的:Docsifysiteongitubpage
例子如何创建一个网站吗?通过编辑HTML文件和一些减价文本您可以使用docsify文档来创建一个漂亮的网站。你怎么认为?请留言分享其他的开源工具可以用于githubpages。