搭建MarkDown文档整理对外展示网站

最新推荐文章于 2025-06-27 10:40:57 发布
置顶 最新推荐文章于 2025-06-27 10:40:57 发布
阅读量5.1k 收藏 11
点赞数 5
CC 4.0 BY-SA版权
分类专栏： javascript jQuery node connect
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/xuyanquan/article/details/84635720
为解决公司内部多个研发团队文档管理及展示需求，开发了一个类似GitBook的Markdown文档展示网站，支持右上角大分类和左侧导航多级嵌套，便于非技术人员编写文档，通过简单配置即可运行。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

考虑到公司需要对外提供自己研发的文档供他人使用。而各个研发组织属于不同组，相当于开放平台一样。于是开发了一个网站专门用来展示整理MarkDown文件。

项目github地址：doc-website

展示如下：

展示如下

配置简单方便，和gitbook类似。部署运行方便。

增加了右上角大分类，和左侧导航多级嵌套。也方便非研发人员进行编写文档。里面的示例文件和目录说明很清晰。只需要管理doc文件夹即可。如果进行扩展修改页面，也可以在assetes里面修改。代码非常少。

项目目录如下：

 

 

项目github地址：doc-website

34、文档组合与轻量级框架
b0c1d2的博客
06-18 21
本文探讨了文档组合的原理及其在最终用户开发（EUD）中的应用，介绍了轻量级框架的优势及具体实现方法。通过合理选择框架和组合策略，非专业开发者也能高效创建和管理文档或应用程序。文章还结合实际案例分析了如何利用这些技术搭建内部知识库，并提供了技术选型对比和开发流程指导。
在不同WIFI环境下访问esp32搭建的web服务器？
**My Coding Family**
06-09 1104
🏆 本文收录于《全栈Bug调优(实战版)》专栏，致力于分享我在项目实战过程中遇到的各类Bug及其原因，并提供切实有效的解决方案。无论你是初学者还是经验丰富的开发者，本文将为你指引出一条更高效的Bug修复之路，助你早日登顶，迈向财富自由的梦想🚀！同时，欢迎大家关注、收藏、订阅本专栏，更多精彩内容正在持续更新中。让我们一起进步，Up！Up！Up！    备注： 部分问题/难题源自互联网，经过精心筛选和整理，结合数位十多年大厂实战经验资深大佬经验总结所得，数条可行方案供所需之人参考。
markdown网站实例
12-02
一个国外用markdown写的网站blog实例，效果很高大上
基于Docusaurus 快速搭建Markdown 系统文档网站
acheng
05-16 738
来试试包括文档分版、本地化、自定义搜索、个性化主题在内的。官网 docusaurus.io ，可以去官网看详细，，让你的网站具有交互能力。💸 自己造轮子是一件苦差事。（个人网站、产品、博客、营销主页，等等）.，只需编写 Markdown 文件即可。⚡️ Docusaurus 会帮助你在。🧐 Docusaurus 是一款。可以搭建带有快速客户端导航的。安装 NODE ,版本16 以上。来获取灵感，并读读其他人的。yarn start 运行。yarn build 发布。
MD文档制作与安全指南
weixin_29935511的博客
05-18 1340
Typora是一个现代的Markdown编辑器，它的特点是可以即时预览Markdown文档的渲染效果，提供了极佳的写作体验。不同于其他编辑器，Typora在编辑和预览Markdown文档时使用的是同一界面，这一设计大大提高了工作效率，使得用户在编写文档的同时，能够实时查看文档的最终显示效果。Typora的即时预览功能极大地提升了Markdown文档的编辑效率，其简洁的用户界面和强大的主题支持也增强了用户的写作体验。
你会用 markdown ，那你会部署文档网站吗
weixin_43487782的博客
10-10 1313
相信大家平时都会用 markdown 编写文档，特别是配合 Typora 使用非常方便。但很多时候我们不满足于本地文档，而是要把文档做成在线的形式，这样如果内容更新，团队成员都可以及时看到。 那么其实用来生成静态网站的开源项目也有不少，例如 VuePress ，Docsify 等，特别是 VuePress 已经广泛用于 Vue 官方文档在内的各种文档的部署。但是 VuePress 是基于 Vue 的，而本人现在团队主要使用 React 技术栈，于是采用了和 VuePress 类似的由 facebook 团队
2-markdown转网页页面设计 --[制作网页模板]
桃园码工的博客
01-04 1683
当你将Markdown格式的博文转换为网页样式时，页面设计的选择可以极大地影响用户体验和网站的专业性。以下是几个适合个人网站的Markdown博文转网页样式的布局示例：
vue markdown内容网页展示
six_teen的博客
12-06 1491
之前使用了mavonEditor这款Markdown编辑器进行博客文章的编写， 最近在弄把博客文章进行网页展示效果，开始使用marked.js，但是代码高亮问题导致页面样式及其的丑陋。后面又在网上四处寻找方法，最后产生想法，要是能用mavonEditor将Markdown的内容展示该多好呢。 然后就在网上查询资料，最后还是找到了方法（不得不说，面向百度编程真的很妙） 首先下载好mavonEditor之后，然后在vue中引用之后，接着就是对mavonEditor这个组件的属性进行设置 <mavon-ed
Dify框架面试内容整理-如何快速搭建一个基于Dify的应用？
不务正业的猿
04-27 200
如果你没有 Docker，也可以手动部署 Python 环境（但更复杂，不推荐初学者）。在你的应用中启用「知识库检索」选项，Dify会自动在用户提问时调用知识内容生成答案。调整 Prompt 或参数（如温度、最大 Token 数）以优化结果。选择一个默认模型（如 gpt-3.5-turbo 或 gpt-4）。使用 Dify 的 API 接口将应用接入外部系统、移动端、微信等。系统会自动提取文本、分块、Embedding、存入向量数据库。或者国内大模型（如智谱、讯飞等）的接口信息。
【话题】如何打造一份优秀的技术文档
IT古董
11-28 950
技术文档是技术人员之间传递信息、记录知识和保障项目顺利进行的重要工具。在技术开发的各个阶段，优秀的文档不仅能提高效率，还能降低沟通成本，为团队协作铺平道路。然而，编写一份清晰、全面且易于维护的技术文档并不容易。本文将从文档的目标、结构、编写原则、工具选择、维护策略等多个方面，详细阐述如何打造一份优秀的技术文档。
Maven项目文档生成：site插件使用指南
最新发布
AI开发架构师
06-27 714
在软件开发中，“代码会过时，但文档永远新鲜”。项目文档是团队协作的"地图"，是新人快速上手的"说明书"，更是对外展示项目的"名片"。Maven的site插件能自动整合项目信息（如API文档、测试报告、代码检查结果），生成结构清晰的静态文档站点。site插件的核心功能与工作原理关键配置文件（site.xml）的编写技巧常用报告插件的集成方法文档生成与发布的完整流程用"整理家庭相册"的故事引出site插件核心概念（site插件、site.xml、报告插件）的通俗解释。
从markdown生成静态html页面的最简单的方法
08-10
从markdown生成静态html页面的最简单的方法
本地快速搭建MarkDown语法网站
Promise的博客
09-29 2398
又到了愉快的周末，再上一天班就十一长假喽~继续记录点自己晓得的东西！ 主要是在之前跟人学的快速搭建一个简单的网站，可以通过这样的方式把相关的文档美美的放在服务器上，然后给别人看也好，自己也能熟系熟系MarkDown的语法并学习，要是接口文档还是推荐通过swagger去实现。 首页效果图 主要使用docsify文档系统 官方github地址：https://github.com/docsifyjs...
Docsify：快速用Markdown文档搭建网站的利器
LW的技术小筑
07-29 978
对于经常写博客的人来说，markdown大家都不陌生。今天介绍一个在最近需求中碰到的软件Docsify，通过它能够将Markdown直接转换为网页。话不多说，下面直接介绍它的快速用法。
动手写一个简单的浏览器扩展插件 - markdown文件本地预览
weixin_33690963的博客
07-03 963
平时写文档的时候，一些简单的文档都用 markdown来写，编辑工具自然是随便用的，记事本、vs code或者专门的 md编辑器都可以，但是想要预览的时候，却有一定的限制，例如我想用 vs code预览 md文件，就必须装一个专门的插件，或者干脆就要开启一个 md编辑器才行，而我的本意其实仅仅是想预览一个写好的 md文档，不会做任何的改动，上面几种做法也不费什么事，但未免有些多余，毕竟，代码编辑器...
Markdown 高效建站指南 Hugo/Typora/Chevereto/Docker/Nginx
dwh0403的专栏
12-01 1519
Markdown 高效建站指南 Hugo/Typora/Chevereto/Docker/Nginx 2020年11月7日 1. 概览 本系列博客使用 Markdown 编写，建站工具为 Hugo，Markdown 编辑器采用 Typora，图床使用自建的 Chevereto，生产环境部署采用 Nginx + Docker 。 最终形成的效果是可以对于本地的截图在 Typora 粘贴过程中自动上传到 Chevereto 搭建的图床，极大地方便了图文排列的 Markdown 问题，由于采用自建图床也.
用markdown写个博客网站吧
yan1915766026的博客
10-17 755
教你搭建个人博客，也适用于写文档
文档服务器搭建markdown,markdir - 一个用于渲染markdown文件的简单HTTP服务器
weixin_28802499的博客
08-11 5470
markdirMarkdir serves up a directory of files in HTML, rendering Markdown files into HTML when they are encountered as .md files. It's sort of the most degenerate Wiki you could imagine writing short ...
docsify - 生成文档网站简单使用教程
weixin_33874713的博客
12-31 3350
1. docsify介绍 docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行。 这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 .html 文件“污染” commit 记录，只需要创建一个 ind...
掌握docsify基础：快速搭建Markdown文档教程
资源摘要信息:"docsify是一个动态生成文档网站的工具，它非常轻量，没有复杂的配置，可以直接拖拽MD文件到页面上生成文档。以下是关于docsify的基本使用的详细介绍。" 一、docsify简介 Docsify是一个简单易用的文档...
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值