首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
您找到你想要的搜索结果了吗?
是的
没有找到

搭建高考文档

由于天朝特殊的网络环境,服务器在国外的 HackMD 在中国完全无法访问。虽然编辑者可以科学上网,但读者未必有这个条件。 无法全文搜索。...于是我花费一个下午的时间,搭建了高考文档,以解决以上两个问题。 框架选取 最终选择了 Docsify,有如下优点: 方便快捷。单文件部署,直接渲染 markdown 文件,无需额外工作。...静态化部署,无需服务器。 PWA 支持,一定程度上缓解海外服务器访问缓慢的问题。...部署方法:在根目录下新建 index.html,将官方文档中的示例代码拷贝进去。 做了一些基础的配置: 更换主题,支持黑夜模式。 添加全文搜索插件。 添加折叠目录插件。...在新建文档时自动更新侧边栏 大体上感觉这是个吃灰项目,以后再说吧。

1.1K30

前端文档站点搭建方案

文档以 Markdown 的形式放在 GitLab 中,以便文档的维护 熟悉 Git 的小伙伴知道 GitLab 是可以设置钩子 (Hook) 的,通过设置钩子可以实现当我们提交代码后,服务端知道在哪个分支修改了哪些文件...服务端负责处理 Webhooks 来拉取 GitLab 上最新的文档文件,docsify 负责实时编译文档。 docsify 是一个动态生成文档网站的工具。...改造后的流程: 文档贡献者在 GitLab 上编辑源文件 编辑完成保存后触发 GitLab 的 Webhooks 文档服务接收到 Webhooks 请求后拉取最新的文档 用户刷新页面后 docsify...GitLab 编辑 方案对比 方案二和方案一不同的地方就是把 md 文件渲染成 Html 的一步从服务端改到了浏览器端,服务器端只承担接收 Webhook 拉取最新的代码的工作。 ?...一个顺手的文档站点搭好之后,接下来我们就只需要关心如何把 Markdown 写好推送到 GitLab,其它的工作服务器都会帮我们完成。

1.5K10

vitepress搭建markdown文档博客

Vite 而不是 Webpack 所以更快的启动时间,热重载等使用 Vue3 来减少 JS 的有效负载vuePress=webpack+vue2,vitePress=vite+vue3html目前主流搭建文档站点的方式...(Vue)除了 VitePress 之外,其他都是用 Webpack 作为开发服务器。一个只有几页的简单文档站点启动开发服务器所花费的时间变得难以忍受。...Vite 的出现很好地解决了这些问题:近乎即时的服务器启动、仅编译所服务页面的按需编译以及闪电般快速的 HMR。 VuePress v1 在本质上是一个 Webpack 应用程序。...更糟糕的是,当项目有不少页面时,服务器必须首先彻底编译每一个页面,而后才能显示任何内容Vite 很好地解决了这些问题:服务器几乎当即启动,按需编译只编译所服务的页面,以及快速的 HMR。...//juejin.cn/post/6965510644007665671转载本站文章《vitepress搭建markdown文档博客》,请注明出处:https://www.zhoulujun.cn/html

1.4K20

dumi 搭建文档型博客

前言 之前已经讲过如何利用网上各种开源的框架来搭建自己的博客,比如 docsify、Hexo、VuePress、Halo 等。...前三者可以直接搭配 Github 就能免费得到一个专属自己的博客,而 Halo 可能需要自己有服务器,然后将服务部署在自己的服务器里。 最近在网上冲浪的时候,又发现了一款文档工具,那就是 dumi。...这是一款为组件开发场景而是的文档工具,和 father 组成一条龙服务。father 负责构建,dumi 则负责组件开发以及组件文档的生成,一起为开发者提供了一站式的组件开发体验。...今天就一起来看看,如何利用 dumi 搭建自己的文档型网站。...接着我们在 docs 目录下新增修改 Markdown 文档,它就会帮我们自动渲染到前端页面中。 总结 以上就是利用 dumi 搭建文档型网站的具体过程了。

1.2K20

基于VuePress和github用搭建服务器的博客、文档系统

基于VuePress和github用搭建服务器的博客、文档系统 最近想做一个项目介绍自己的一些项目和日常的文档,让文档有个属于自己的家,https://{你的域名} 使用gitbook之后,又看到了vuepress...,它的诞生初衷是为了支持 Vue 及其子项目的文档需求。...简单的说它就是一个快速建设文档站点的工具,在简单配置好功能后,需要做的事情就剩下写好一个个 Markdown 文档,并且可以将其发布到github pages中 vuepress官网:https://vuepress.vuejs.org.../zh/ [基于VuePress用无服务器博客、文档系统] 一、安装nodejs和yarn 笔者是windows11系统,打开官网:http://nodejs.cn/download/ 我这里下载的是...四、在本地启动服务器 # yarn docs:dev # npm run docs:dev 当出现以下可以在浏览器中访问本机IP+端口访问 > VuePress dev server listening

35110

基于VuePress和github用搭建服务器的博客、文档系统

基于VuePress和github用搭建服务器的博客、文档系统 最近想做一个项目介绍自己的一些项目和日常的文档,让文档有个属于自己的家,https://g.xgss.net 使用gitbook之后,又看到了...既可以当做博客系统、文档系统,项目介绍的系统,还有丰富的插件使用。 要用到的域名: http://vuepress.xgss.net (github pages)的域名。...,它的诞生初衷是为了支持 Vue 及其子项目的文档需求。...简单的说它就是一个快速建设文档站点的工具,在简单配置好功能后,需要做的事情就剩下写好一个个 Markdown 文档,并且可以将其发布到github pages中 vuepress官网:https://vuepress.vuejs.org...四、在本地启动服务器 # yarn docs:dev # npm run docs:dev 当出现以下可以在浏览器中访问本机IP+端口访问 > VuePress dev server listening

40410

拥抱腾讯云服务:Github Actions+COS,快速搭建你的Wiki文档

现负责腾讯云对象存储前端的工作,致力于挖掘更多云服务的玩法。 想要一个自己的静态站点,没有服务器 ? 想要所写即所得的方式,书写自己的文档? 想要一推到代码仓库,就自动完成站点部署?   ...如何用腾讯云COS对象存储快速搭建一个在国内就能快速访问的Wiki文档站点?   下面给熟悉或者不熟悉腾讯云对象存储COS的同学普及下COS静态网站这个最实用的功能。...今儿要用到他的静态网站功能,即免服务器,把你用Docsify写的Markdown文件,以静态页面的方式,提供了一个页面地址供你进行访问。...这自然想到了Github自带的CI服务Github Actions。思路比较简单,在代码提交时去做一些事情,比如这里是在代码提交时,触发Action去把文档部署到 COS。   ...这里可以使用“云服务SCF”,这里就不做额外的讲解了。

3K10

使用 MkDocs 快速搭建文档系统

MkDocs 是快速,简单和华丽的静态网站生成器,可以构建项目文档文档源文件在 Markdown 编写,使用单个 YAML 配置文件配置。...MkDocs 基于 python,但只需编写 Markdown 就可构建最简单的文档页面 安装 使用 pip 安装 MkDocs pip install mkdocs-material 创建项目 使用如下指令创建一个名为...这是我使用的配置,可供参考 site_name: XXX 使用文档 theme: name: material language: zh # 网站左上角显示的logo logo: images...icon: fontawesome/brands/github link: # name: github  复制 编写 Markdown 并构建网页 编写前可以创建一个实时预览的服务器...mkdocs serve 在docs/中创建的md文件将会实时同步到预览服务器 完成编辑后使用 mkdocs build 即可生成静态网页文件,可以部署到github pages或者你的个人服务器上

96420

Linux在线搭建自己的文档网站

1. teedoc 简介 一款用 Python 写的文档网站生成工具,支持从 Markdown 或者 jupyter notebook 转换成 HTML,支持多文档,多语言,支持自定义页面等功能 效果和文档...teedoc.neucrack.com 或者 https://teedoc.github.io/ 软件源码: https://github.com/neutree/teedoc (欢迎 star) 文档源文件...: github.com/teedoc/teedoc.github.io 将 Markdown 或者 Jupyter Notebook 格式的文档转换为 HTML 网页 像其他工具也有read the...特性 使用简单, 跨平台,只依赖 Python3 部署简单, 生成的网站是全静态页面,直接拷贝到服务器或者上传到三方机构即可部署 书写简单,使用 Markdown 语法编写 Jupyter notebook...支持 多文档支持 插件支持 多主题支持(由插件实现) 多级目录支持 多语言支持(手动翻译)(国际化/i18n) 多语言支持(自动翻译) 多版本支持(实现方法同多语言) 搜索支持 SEO 友好 实时预览更改

4.4K50

使用gitbook快速搭建文档中心

背景 在研发一个系统,主要给公司内部同事用,按理说,简单点的话,搞个使用文档就行了,但产品经理希望是做成一个文档中心,比如,你学习个新技术的时候,比如vue,一般有个在线的帮助文档,他的想法就是这种。...image-20231021154919586 我们就开始了调研,刚开始看了下wordpress(好多云服务器支持用这个来搭建网站),后面发现好复杂,我们只需要一个清爽的帮助文档而已;后面发现文档中心这种...,主要分两类,一类是动态的,有数据库,有后台管理界面,可以在后台管理中去发布文档;一种是静态的,基本就是提供写好的markdown,然后部署到服务器上,用特定技术预先渲染成html,再利用nginx之类的指向这些...html,一个静态文档中心就有了。...前一阵调研了一个叫gitbook的,属于静态方案,这里简单记录下搭建过程。

1.5K10
领券