使用markdown编写技术文档并部署到GitHub

最新推荐文章于 2024-03-18 10:47:00 发布
最新推荐文章于 2024-03-18 10:47:00 发布
阅读量1.6k 收藏 3
点赞数
文章标签： github git vercel markdown
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44198589/article/details/125799348
版权

目录

一、创建GitHub仓库

  1. 首先创建一个新的GitHub仓库

在这里插入图片描述

  1. 复制新生成的.git 地址

在这里插入图片描述

  1. 在本地创建文件夹并clone刚生成的项目

在这里插入图片描述

  1. 在该文件夹下添加文件

文件1：_coverpage.md

# Note record <small>xxxxxxxxxx</small>

<a href="https:// xxxxxxxxxxxx ">Github</a>
<a href="#README">Get Started</a>

文件2：_siderbar.md

- Start
  - [Overview](/README.md)
  
- Note
  - 21
  - 22
    - [22.6](/22/xxxxxx.md)

文件3：index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>xxxxxxxxxx</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="https://cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
  <!-- vue主题样式 -->
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">

</head>
<body>
  <div id="app">loading...</div>
  <script>
    window.$docsify = {
      name: 'xxxxxxxxxx',
      repo: 'xxxxxxxxxx',

      basePath: '/', // 资源相对路径
      nameLink: '/', // 点击文档标题后的跳转地址
      externalLinkTarget: '_blank', // 外部链接的打开方式，默认_blank
      cornerExternalLinkTarget: '_blank', // 右上角链接的打开方式。默认为 _blank
      routerMode: 'hash', // 路由方式 默认hash
      notFoundPage: true, // 在找不到指定页面时加载_404.md
      auto2top: true, // 切换页面后是否自动跳转到页面顶部

      loadSidebar: true, // 加载侧边栏
      coverpage: true, // 展示封面
      
      subMaxLevel: 2,
      // search: 'auto'
      search: { // 搜索插件配置
          paths: 'auto',
          placeholder: '🔍 搜索',
          noData: '😞 没有结果!'
      },
      count: { // 字数统计插件配置
          countable: true,
          fontsize: '0.9em',
          color: 'rgb(90,90,90)',
          language: 'chinese'
      },
      pagination: { // 分页插件配置
          previousText: '上一章节',
          nextText: '下一章节',
          crossChapter: true,
      },

    }
  </script>
  <!-- Docsify v4 -->
  <script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
  <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>

</body>

<!-- <script src="https://cdn.jsdelivr.net/npm/docsify@4"></script> -->
<!-- <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script> -->
<!--全局搜索插件-->
<script src="https://unpkg.com/docsify-count/dist/countable.js"></script>
<!--字数统计插件-->
<script src="https://cdn.jsdelivr.net/npm/docsify-copy-code"></script>
<!--代码段复制插件-->
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>
<!--图片缩放插件-->
<script src="https://unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
<!-- 阅读进度条插件 -->
<!-- <script src="https://cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js"></script> -->
<!-- 暗黑主题切换插件 -->

</html>
  1. 更新GitHub仓库
git add .

git commit -m "updata"

git push origin main

在这里插入图片描述

二、部署到vercel

vercle 链接

  1. 我这里已经添加过一个项目了，再次添加的话需要再次点 + Add GitHub Account
    在这里插入图片描述

  2. 然后选择要添加的仓库

在这里插入图片描述

  1. 最后选择部署

在这里插入图片描述
结束

NanoNino
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
第01课：Markdown 在 GitHub
zoomquiet的博客
09-22 633
GFM !-) 为毛? 出没. md 配合的工具 问题->mail gh-pages ipynb? 提问 GFM !-) GitHub 其实是伪装成 git 仓库的 Markdown 编辑平台 GitHub 对 Markdown 是狂热的 从发布之初就宣称: GitHub Flavored Markdown GitHub 将这种狂热传染给了全球开发者，以致到后来所有 ...
本地Markdown文档部署到云服务器,实现类似看云的功能
zhishunet
04-09 1341
搭建一个属于自己的网页版Markdown阅读器、随手写的文字即可无缝对接到你的服务器实现类似看云的功能(简易版)
创建个人网站（github pages）并将站点一键托管到Github
weixin_45205599的博客
04-08 1437
个人网站搭建：使用静态网站生成工具mkdocs，迅速便捷将markdown编写的文本文件生成个人wiki网站并托管到github供大家访问的全流程总结，保姆级教程，多处踩坑的血泪经验史。
拓展阅读：使用Markdown编写文档
最新发布
zhrb
03-18 316
拓展阅读：使用Markdown编写文档 本文博客链接 目录拓展阅读：使用Markdown编写文档1. 引子2. Markdown简介与应用2.1 Markdown是什么？2.2 Markdown的应用3. 学习Markdown3.1 Markdown的相关工具3.2 基本概念与标记符号3.2.1 基本概念3.2.2 基本的标记符号3.2.3 一个Markdown文档示例一、Markdown文本渲...
如何在Github上用Markdown写好ReadMe
weixin_30951389的博客
04-25 231
MarkDown的基本语法（可以直接复制下述内容到github的readme.md显示结果） 一、标题写法：第一种方法：1、在文本下面加上 等于号 = ，那么上方的文本就变成了大标题。等于号的个数无限制，但一定要大于0个哦。。2、在文本下面加上 下划线 - ，那么上方的文本就变成了中标题，同样的 下划线个数无限制。3、要想输入=号，上面有文本而不让其转化为大标题，则需要在两者之间加一个空行。...
github官方markdown使用说明（GFM）
01-08
本文档是PDF版本，是github官方关于markdown的使用说明
使用 VS Code + Markdown 编写 PDF 文档.doc
07-09
使用 VS Code + Markdown 编写 PDF 文档 本文将指导读者如何使用 VS Code + Markdown 编写 PDF 文档，涵盖了 Markdown 的基本语法、环境准备、使用指引等方面的知识点。 一、环境准备 要使用 VS Code + Markdown ...
bookdown：使用R Markdown编写书籍和技术文档
02-03
bookdown：使用R Markdown编写书籍和技术文档
github-markdown-render：使用GitHub的Markdown渲染API和CSS在本地Web服务器上显示Markdown格式的文档，以模仿GitHub本身的视觉效果
02-04
使用GitHub的和CSS在本地开发Web服务器上显示格式的文档，以模仿GitHub本身的可视显示。 方便在项目存储库中创作/预览README.md文件（或与此有关的任何Markdown），希望避免由于过多的错别字/错误而在提交日志中...
sapper-blog:基于sapper，将markdown文章转为html后部署到github pages
05-13
编写文章路径为src/_posts，在此目录下，运行下面命令将监听markdown文件并生成routes/blog/_posts.js。如果项目已在运行的话，可以在本地实时查看文章情况。node generate.js后续会进行更新优化页面样式。
rmarkdown-test:创建R Markdown文档并发布到GitHub Pages的示例
04-07
rmarkdown测试 创建R Markdown文档并发布到GitHub Pages的示例
对接github的markdown项目钩子解析markdown为博客
08-10
对接github的markdown项目钩子，解析markdown为博客
Github上Markdown基本语法
weixin_34110749的博客
02-04 324
基础写作和语法格式 本篇文章的内容来源于Github的基础写作帮助.如果在观看时有什么问题，可以直接查阅源文件。另外需要说明的是Git对Markdown的支持增加了一些扩展功能，因此在Git上可以渲染的Markdown语法并不一定在仅支持标准Markdown语法的平台上运行。 本文后续还有对GitHub上Markdown语法的高级应用的介绍。 标题 Markdown中标题如果想定义一个标题，可以在...
搭建MarkDown文档整理对外展示网站
xuyanquan的专栏
11-29 4909
考虑到公司需要对外提供自己研发的文档供他人使用。而各个研发组织属于不同组，相当于开放平台一样。于是开发了一个网站专门用来展示整理MarkDown文件。 项目github地址：doc-website 展示如下： 配置简单方便，和gitbook类似。部署运行方便。 增加了右上角大分类，和左侧导航多级嵌套。也方便非研发人员进行编写文档。里面的示例文件和目录说明很清晰。只需要管理doc文件夹即...
使用markdown在github Page上写博客
terrylu87的专栏
02-15 1228
原文地址 转载请注明出处 1 使用Markdown+jekyll在github page上写博客 1.1 在本地测试 1.1.1 如果局域网无法访问 想用手机测试移动端的排版质量，结果访问被拒绝,如下图： 把 &lt;username&gt; 换成自己的 github 帐号，运行以下命令： $ git clone https://github.com/&lt;uername&gt;/&lt...
Github+Typora - - 我理想中的markdown云笔记神器
热门推荐
qq_38056704的博客
12-03 2万+
这篇文章记录我如何解决市面上markdown笔记软件的弊端，扬长避短，为喜爱markdown软件的朋友出一份力。 首先，我们先看下这篇文章，介绍了我们当下markdown软件多多少少有些不完美的状况，让我们虽然不喜欢，但也只可“欲罢不能”的尴尬。 结合个人经历，简单分析一下当下的笔记软件都有什么弊端   Onenote 优点：你可以在任何可以点击的地方编辑你想说的话，自由度非常非常大！！...
github上传文件和编写.md格式文件
spring_willow的博客
04-08 1万+
一、利用git bash上传文件到github上和克隆文件到本地其实我们在github中创建完仓库就可以直接上传文件了第一步：第二步：第三步：我之所以用git上传的原因是因为有的时候网络不好，这种方法上传不上去，其实git的功能很强大，只是目前我还用不到，也有人说用这个没办法在库中创建文件夹，其实只需要在文件夹与文件之间加一个“/”就可以形成文件夹了，演示一下：第一步：第二步：用git bash上...
如何使用github建站（简易，使用Markdown编辑）
王子赫的博客
07-10 1102
有很多人都想建立自己的网站，但是因为一般建站都需付费来租用服务器，这次让我介绍一下如何用github建站。 1.访问github官网，有时可能会加载失败，刷新一下应该就能解决。 2.注册或登录账号。 3.点击 4.点击右上角点的New，新增资源库 5.把资源库名命名为你的github账号.github.io，如zhangsan.github.io 6.点击 ADD a README file 7.再按Create repository新增库 8.再按中间的修改按钮通过Markdown来修改readme.
鼠标右键创建html,鼠标右键新建Markdown文档
weixin_39634878的博客
05-31 121
首先放一张github某项目中.md文件中的内容图片Windows系统下，使用 Typora 软件来进入Markdown文档的编写非常容易，而且入门门槛非常的低存在的问题：习惯了使用Markdown来编写各种文档，以及打开Typora软件来编辑Markdown，但是Typora软件比较客气，并没有给我们用户修改一大堆配置。当我想在桌面或文件夹内新建一个.md(markdown文档的后缀名)文件时，...
docsify对部署在github上的markdown文档进行加密
09-12
### 回答1： docsify 可以通过一些插件实现对 markdown 文档的加密。具体来说，你需要使用 docsify-encrypt-plugin 插件来实现 markdown 文档的加密。 以下是实现步骤： 1. 在你的项目根目录下安装 docsify-encrypt-plugin 插件： ``` npm install docsify-encrypt-plugin --save-dev ``` 2. 在你的 docsify 项目配置文件中，启用插件并设置密码： ```javascript window.$docsify = { // ... plugins: [ // ... function(hook, vm) { hook.beforeEach(function(content) { return vm.encrypt(content, 'password'); }); } ] }; ``` 在上述代码中，将 password 替换为你自己设置的密码。 3. 在 markdown 文档中，使用以下语法对需要加密的内容进行标记： ``` <!--encrypt 需要加密的内容 --> ``` 例如： ``` <!--encrypt 这是需要加密的内容。 --> ``` 4. 将加密后的 markdown 文档上传到 GitHub 上的仓库中。 现在，其他人在查看该 markdown 文档时，会看到加密后的内容，需要输入密码才能查看解密后的内容。 注意：该插件只能对 markdown 内容进行加密，而无法对图片等其他类型的文件进行加密。 ### 回答2： docsify 是一种用于生成文档网站的工具，它可以将 Markdown 格式的文档直接转化为一个漂亮的网站。然而，docsify 本身并不提供加密功能，也不能直接对在 GitHub 上部署的 Markdown 文档进行加密。 要对在 GitHub 上部署的 Markdown 文档进行加密，可以考虑以下的方法： 1. 使用私有仓库：在 GitHub 上创建一个私有仓库，并将 Markdown 文档放置在私有仓库中。这样只有被授权的用户才能查看和访问这些文档。 2. 使用加密工具：在本地使用加密工具将 Markdown 文档进行加密，然后将加密后的文档上传到 GitHub。这样，只有解密后的文档才能被正确阅读。但是需要注意的是，这种加密方式可能需要事先与阅读者共享解密方法或密码，以确保文档能够被正确解密和阅读。 3. 使用访问控制：在 GitHub 仓库设置中，可以选择限制特定人员或特定团队对仓库的访问权限。通过细粒度的访问控制，可以在 GitHub 上控制谁可以查看和访问 Markdown 文档。 总的来说，将 Markdown 文档进行加密并在 GitHub 上进行部署并不是 docsify 的主要功能。为了保护文档内容的安全性，建议使用 GitHub 提供的访问控制功能或其他专门的加密工具，并与所需的用户进行必要的信息共享和授权。 ### 回答3： docsify是一款非常方便的工具，可以让我们在GitHub上部署Markdown文档并进行加密保护。我们可以使用docsify自带的插件或者第三方的插件来实现加密功能。 首先，我们需要在GitHub上创建一个新的仓库，用于存放我们的Markdown文档和docsify的配置文件。然后，我们将Markdown文档保存在该仓库中的指定文件夹内。 接下来，我们需要在项目的根目录下创建一个名为"_sidebar.md"的文件，用于配置docsify的侧边栏菜单。在该文件中，我们可以指定需要加密的文档，并为其添加密码。 在docsify插件中，有一个名为"docsify-plugin-lock"的插件，可以用于加密文档。我们可以在docsify的配置文件中引入该插件，并进行相关的配置。通过该插件，我们可以为指定的Markdown文档添加密码，并且只有输入正确的密码后才能访问该文档。 除了使用docsify自带的插件外，我们还可以使用第三方的插件来实现文档加密。例如，"docsify-password"插件可以通过设置密码保护整个docsify文档。我们只需要在配置文件中引入该插件，并设置密码即可。 综上所述，我们可以使用docsify及其插件来对部署在GitHub上的Markdown文档进行加密，保护文档内容的安全性。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值