【小沐学写作】Docsify制作在线电子书、技术文档(Docsify + Markdown + node)

本文主要是介绍【小沐学写作】Docsify制作在线电子书、技术文档(Docsify + Markdown + node),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 1、简介
  • 2、安装
    • 2.1 node
    • 2.2 docsify-cli
  • 3、配置
    • 3.1 初始化
    • 3.2 预览效果
    • 3.3 加载对话框
    • 3.4 更多页面
    • 3.5 侧 栏
    • 3.6 自定义导航栏
  • 结语

1、简介

https://docsify.js.org/#/?id=docsify

一个神奇的文档网站生成器。

  • 简单轻巧
  • 没有静态构建的 html 文件
  • 多个主题

在这里插入图片描述
Docsify会即时生成您的文档网站。与 GitBook 不同,它不会生成静态 html 文件。相反,它会智能地加载和解析您的 Markdown 文件,并将它们显示为网站。要开始使用它,您需要做的就是创建一个并将其部署在 GitHub Pages 上。

  • 没有静态构建的 html 文件
  • 简单轻巧
  • 智能全文搜索插件
  • 多个主题
  • 有用的插件 API
  • Emoji 支持
  • 与IE11兼容
  • 支持服务端渲染

2、安装

2.1 node

https://nodejs.org/en
Node.js® 是一个开源的跨平台 JavaScript 运行时环境。
在这里插入图片描述

node -v
npm -v

在这里插入图片描述

2.2 docsify-cli

建议全局安装,有助于在本地初始化和预览网站。

npm i docsify-cli -g
# npm i docsify-cli
# npm install --prefix ./ 包名   , 就会将包安装在当前文件夹
# npm install --prefix ./ docsify-cli

在这里插入图片描述

3、配置

3.1 初始化

执行命令如下:

docsify init ./docs

运行结果如下:
在这里插入图片描述
生成文件夹和文件如下;
在这里插入图片描述
在这里插入图片描述
完成后,您可以在子目录中看到文件列表。

index.html作为条目文件
README.md作为主页
.nojekyll防止 GitHub Pages 忽略以下划线开头的文件

3.2 预览效果

使用 运行本地服务器。您可以在 上的浏览器中预览您的网站。

docsify serve docs

在这里插入图片描述
浏览器访问:

http://localhost:3000

在这里插入图片描述
如果您的系统上安装了 Python,您可以轻松地使用它来运行静态服务器来预览您的站点。

# python2
cd docs && python -m SimpleHTTPServer 3000# python3
cd docs && python -m http.server 3000

在这里插入图片描述
同时修改文件index.html中的标签内容后,浏览器预览如下:<br/> <img src="https://img-blog.csdnimg.cn/direct/4196ad3e9f174b1d991a3803b952e1bb.png" alt="在这里插入图片描述"/>

3.3 加载对话框

如果需要,您可以在 docsify 开始渲染文档之前显示一个加载对话框:

<!-- index.html --><div data-app id="main">Please wait...</div><script>window.$docsify = {el: '#main',};
</script>

3.4 更多页面

如果你需要更多页面,你可以简单地在你的docsify目录中创建更多的markdown文件。

.
└── docs├── README.md├── guide.md└── zh-cn├── README.md└── guide.md

3.5 侧 栏

为了拥有侧边栏,您可以创建自己的侧边栏.

<!-- index.html --><script>window.$docsify = {loadSidebar: true}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>

创建 文件:_sidebar.md

<!-- docs/_sidebar.md -->* [Home](/)
* [Guide](guide.md)

浏览器预览如下:
在这里插入图片描述

从侧边栏选择设置页面标题:
页面的标签是根据选定的侧边栏项目名称生成的。为了获得更好的 SEO,您可以通过在文件名后指定字符串来自定义标题。

<!-- docs/_sidebar.md -->
* [Home](/)
* [笔记](guide.md "小沐的第一篇笔记")

在这里插入图片描述

3.6 自定义导航栏

如果需要自定义导航,可以创建基于 HTML 的导航栏。

<!-- index.html --><body><nav><a href="#/">EN</a><a href="#/zh-cn/">简体中文</a></nav><div id="app"></div>
</body>

在这里插入图片描述
添加参数:loadNavbar: true

<!-- index.html --><script>window.$docsify = {el: '#main',loadSidebar: true,loadNavbar: true}
</script>

新建文件:_navbar.md

<!-- _navbar.md -->* Getting started* [Quick start](quickstart.md)* [Writing more pages](more-pages.md)* [Custom navbar](custom-navbar.md)* [Cover page](cover.md)* Configuration* [Configuration](configuration.md)* [Themes](themes.md)* [Using plugins](plugins.md)* [Markdown configuration](markdown.md)* [Language highlight](language-highlight.md)

在这里插入图片描述

结语

如果您觉得该方法或代码有一点点用处,可以给作者点个赞,或打赏杯咖啡;╮( ̄▽ ̄)╭
如果您感觉方法或代码不咋地//(ㄒoㄒ)//,就在评论处留言,作者继续改进;o_O???
如果您需要相关功能的代码定制化开发,可以留言私信作者;(✿◡‿◡)
感谢各位大佬童鞋们的支持!( ´ ▽´ )ノ ( ´ ▽´)っ!!!

这篇关于【小沐学写作】Docsify制作在线电子书、技术文档(Docsify + Markdown + node)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/532591

相关文章

springboot项目打jar制作成镜像并指定配置文件位置方式

《springboot项目打jar制作成镜像并指定配置文件位置方式》:本文主要介绍springboot项目打jar制作成镜像并指定配置文件位置方式,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录一、上传jar到服务器二、编写dockerfile三、新建对应配置文件所存放的数据卷目录四、将配置文

Python Pillow 库详解文档(最新推荐)

《PythonPillow库详解文档(最新推荐)》Pillow是Python中最流行的图像处理库,它是PythonImagingLibrary(PIL)的现代分支和继承者,本文给大家介绍Pytho... 目录python Pillow 库详解文档简介安装核心模块架构Image 模块 - 核心图像处理基本导入

Qt如何实现文本编辑器光标高亮技术

《Qt如何实现文本编辑器光标高亮技术》这篇文章主要为大家详细介绍了Qt如何实现文本编辑器光标高亮技术,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以了解下... 目录实现代码函数作用概述代码详解 + 注释使用 QTextEdit 的高亮技术(重点)总结用到的关键技术点应用场景举例示例优化建议

基于Python实现一个简单的题库与在线考试系统

《基于Python实现一个简单的题库与在线考试系统》在当今信息化教育时代,在线学习与考试系统已成为教育技术领域的重要组成部分,本文就来介绍一下如何使用Python和PyQt5框架开发一个名为白泽题库系... 目录概述功能特点界面展示系统架构设计类结构图Excel题库填写格式模板题库题目填写格式表核心数据结构

C#实现将Office文档(Word/Excel/PDF/PPT)转为Markdown格式

《C#实现将Office文档(Word/Excel/PDF/PPT)转为Markdown格式》Markdown凭借简洁的语法、优良的可读性,以及对版本控制系统的高度兼容性,逐渐成为最受欢迎的文档格式... 目录为什么要将文档转换为 Markdown 格式使用工具将 Word 文档转换为 Markdown(.

详解如何使用Python构建从数据到文档的自动化工作流

《详解如何使用Python构建从数据到文档的自动化工作流》这篇文章将通过真实工作场景拆解,为大家展示如何用Python构建自动化工作流,让工具代替人力完成这些数字苦力活,感兴趣的小伙伴可以跟随小编一起... 目录一、Excel处理:从数据搬运工到智能分析师二、PDF处理:文档工厂的智能生产线三、邮件自动化:

Python实现自动化Word文档样式复制与内容生成

《Python实现自动化Word文档样式复制与内容生成》在办公自动化领域,高效处理Word文档的样式和内容复制是一个常见需求,本文将展示如何利用Python的python-docx库实现... 目录一、为什么需要自动化 Word 文档处理二、核心功能实现:样式与表格的深度复制1. 表格复制(含样式与内容)2

Java中的登录技术保姆级详细教程

《Java中的登录技术保姆级详细教程》:本文主要介绍Java中登录技术保姆级详细教程的相关资料,在Java中我们可以使用各种技术和框架来实现这些功能,文中通过代码介绍的非常详细,需要的朋友可以参考... 目录1.登录思路2.登录标记1.会话技术2.会话跟踪1.Cookie技术2.Session技术3.令牌技

Maven项目中集成数据库文档生成工具的操作步骤

《Maven项目中集成数据库文档生成工具的操作步骤》在Maven项目中,可以通过集成数据库文档生成工具来自动生成数据库文档,本文为大家整理了使用screw-maven-plugin(推荐)的完... 目录1. 添加插件配置到 pom.XML2. 配置数据库信息3. 执行生成命令4. 高级配置选项5. 注意事

使用Python实现网页表格转换为markdown

《使用Python实现网页表格转换为markdown》在日常工作中,我们经常需要从网页上复制表格数据,并将其转换成Markdown格式,本文将使用Python编写一个网页表格转Markdown工具,需... 在日常工作中,我们经常需要从网页上复制表格数据,并将其转换成Markdown格式,以便在文档、邮件或