首页 > 其他分享 >使用docsify搭建github pages页面

使用docsify搭建github pages页面

时间:2025-01-16 17:45:04浏览次数:1  
标签:md github config 文档 docsify sidebar true pages

目录

docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件,
所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个 index.html 就可以开始编写文档并直接部署在 GitHub Pages。

初始化

可以直接参考官方文档 快速开始

效果参考 docsify页面

相关配置

index.html



<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8"/>
    <title>Document</title>
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
    <meta name="description" content="Description"/>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"/>
    <style type="text/css">
        .sidebar-nav > ul > li.file p > a {
            font-size: 15px;
            font-weight: 700;
            color: #364149;
        }

        .sidebar-nav .folder {
            cursor: pointer;
        }
    </style>
</head>
<body>
<div id="app">
    加载中
</div>
<script>
    window.$docsify = {
        name: '文档',
        repo: '',
        loadSidebar: true,
        subMaxLevel: 2,
        coverpage: true,
        onlyCover: true,
        auto2top: true,
        mergeNavbar: true,

        alias: {
            '/.*/_sidebar.md': '/_sidebar.md'
        },
        count: {
            countable: true,
            fontsize: '0.9em',
            color: 'rgb(90,90,90)',
            language: 'chinese'
        },
        // docsify-pagination
        pagination: {
            crossChapter: true,
            crossChapterText: true,
        },
        search: {
            maxAge: 86400000, // 过期时间,单位毫秒,默认一天
            paths: 'auto', // or 'auto'
            placeholder: '搜索',
            noData: '无结果',
            hideOtherSidebarContent: false, // 是否隐藏其他侧边栏内容
            namespace: 'website-1',
            pathNamespaces: ['/', '/config', '/guide']
        }
    }
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
<script src="//unpkg.com/docsify-count/dist/countable.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>

<script src="//unpkg.com/docsify-sidebar-collapse@1.3.5/dist/docsify-sidebar-collapse.min.js"></script>

<!-- code highlight -->
<script src="//unpkg.com/prismjs@1.27.0/components/prism-bash.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-csharp.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-java.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-json.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-markdown.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-nginx.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-properties.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-sql.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-xml-doc.min.js"></script>
<script src="//unpkg.com/prismjs@1.27.0/components/prism-yaml.min.js"></script>


</body>
</html>

readme.md

默认是使用 readme作为首页的

_sidebar.md

<!-- docs/_sidebar.md -->
* 首页
	* [首页](readme "首页")
	* [指南](guide "很厉害的导航页面")

* 配置
	* [配置说明](config/config)
	* [配置说明1](config/config1)
	* [配置说明2](config/config2)

* 命令
	* [命令1](command/command1)
	* [命令2](command/command2)
	* [命令3](command/command3)

标签:md,github,config,文档,docsify,sidebar,true,pages
From: https://www.cnblogs.com/cpfo/p/18675464

相关文章

  • GitHub打不开的解决方案
    在国内github官网经常面临打不开或访问极慢的问题,那有什么好办法解决GitHub官网访问不了的问题?今天来教你几招轻松访问github官网。首先我们说下github官网打不开的原因到底是什么。我们会发现,github偶尔可以打开,偶尔打不开,能不能打开似乎全靠运气,其实这都是因为你访问github......
  • vscode使用github.211014
    1,vscode打开terminal,生成RSA密钥,并查看蜜月PSD:\\code\\SQL>gitinitReinitializedexistingGitrepositoryinD:/code/SQL/.git/PSD:\\code\\SQL\>gitconfig--globaluser.nameamadeusPSD:\\code\\SQL\>gitconfig--globaluser.emailvegas......
  • 开箱你的 AI 语音女友「GitHub 热点速览」
    随着大模型API服务的不断丰富,开发者无需再依赖昂贵的硬件,也能轻松开发出拥有强大AI能力的应用。这不仅降低了技术门槛,也激发了极客们的创造力。就比如上周飙升1.5kStar的开源项目xiaozhi-esp32,仅用低成本的ESP32开发板和LLMAPI服务,就能制作出一个聪明有趣、......
  • 盘点 GitHub 上可用的微信抢红包插件:原理、项目与安全建议
    快过年了,给大家盘点写好玩的,很多小伙伴应该需要的。我们首选github,GitHub作为全球最大的开源社区,自然也汇聚了不少微信抢红包相关的项目。本篇博客将盘点目前在GitHub上能够找到的部分微信抢红包插件或脚本,介绍其主要原理、使用门槛与风险,为有兴趣了解该领域的读者提供参考......
  • github Desktop小白下载与汉化教程
    GitHubDesktop是一款由GitHub官方推出的图形化工具,旨在简化Git和GitHub的使用流程,特别适合不熟悉命令行的用户。它支持仓库的克隆、创建和管理,方便进行分支操作(如创建、切换和合并分支),并提供了直观的界面来提交、撤销和同步更改。此外,GitHubDesktop还能帮助用户创建......
  • uni-app pages.json
    pages数组:用于定义应用的页面路径、窗口表现、导航栏样式等,它列出了应用中所有的页面路径,并决定了这些页面的加载顺序和一些初始设置。pages数组中的每一项代表了一个页面的配置对象,通常包含以下属性:path(String):必填,表示页面的路径(相对于src或project根目录),不带后......
  • 2025年01月13日Github流行趋势
    1.项目名称:Jobs_Applier_AI_Agent项目地址url:https://github.com/feder-cr/Jobs_Applier_AI_Agent项目语言:Python历史star数:25929今日star数:401项目维护者:surapuramakhil,feder-cr,cjbbb,sarob,thomHayner项目简介:Jobs_Applier_AI_Agent旨在通过自动化求职申请过程来......
  • Cloudflare Pages 搭建 DockerHub 镜像加速器
    登录https://dash.cloudflare.com/进入Workers创建一个Worker名称随意,然后点击部署编辑代码访问https://github.com/cmliu/CF-Workers-docker.io/blob/main/_worker.js复制代码将代码全部替换点部署刷新预览后显示搜索框部署成功点返回,然后选择设置,点添加自定......
  • 【工具箱】GitHub命令行访问配置
    文章目录配置SSH访问配置个人访问令牌(代替原密码)GitHubDesktop其它GitHub是编程社区广泛使用的产品,它的使用范围已经扩展到很多需要多版本控制的系统中了。本文介绍配置GitHub的本地访问的方法,以及图形化界面(GitHubDesktop)的下载方法。配置SSH访问ssh-keygen-......
  • 使用 GitHub Actions 构建 CosyVoice 项目的运行环境镜像并推送到阿里云容器镜像服务
    使用GitHubActions构建CosyVoice项目的运行环境镜像并推送到阿里云容器镜像服务和GitHubPackageRegistry概述本文介绍了如何使用GitHubActions构建CosyVoice项目的运行环境Docker镜像,并将其推送到阿里云容器镜像服务(ACR)和GitHubPackageRegistry。通过挂载本地......