最近在尝试一些项目技术文档搭建的工具,看到网上很多人推荐 gitbook,使用后总体感觉良好。无意中发现一款 Vue 驱动的静态站点生成工具 vuepress,看到官网和demo后立即被它的简约灵活所吸引。一个 vuepress 网站是一个由 Vue、Vue Router 和 Webpack 驱动的单页应用。在构建时,创建一个服务端渲染(SSR)的版本,然后通过虚拟访问每一条路径来渲染对应的HTML。
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
VuePress V2 是一个以 Markdown 为中心的静态网站生成器。你可以使用 Markdown在新窗口打开 来书写内容(如文档、博客等),然后 VuePress 会帮助你生成一个静态网站来展示它们。
在研发一个系统,主要给公司内部同事用,按理说,简单点的话,搞个使用文档就行了,但产品经理希望是做成一个文档中心,比如,你学习个新技术的时候,比如vue,一般有个在线的帮助文档,他的想法就是这种。
转载请标明出处: https://www.jianshu.com/p/307684deff51
leetcode-notebook[1] 的题解越来越多,原先选择 Gitbook[2] 构建解题本的弊端逐渐显现出来,每次补充一道题解重新 build 项目时居然要花上 30 秒左右……
这个安装很简单,只需要下载,然后一路 next 即可。下载链接:https://nodejs.org/en/
GitBook 是一个基于 Node.js 的命令行工具,下载安装 Node.js(我以前搭建 hexo 的文章里也有介绍),安装完成之后,你可以使用下面的命令来检验是否安装成功。
GitBook是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书
这是一篇基于Gitee搭建个人网站的保姆级教程。从零到一。如果你想基于云服务器搭建,我以前写过一篇菜鸟篇。
码云 CommonMark 解析器 之前码云的解析器基于用户的反馈做了很多定制化的修改。 但是随着使用码云的用户越来越多,以及越来越多的Github用户往码云上迁移,我们收到了很多用户反馈。 始料不及
Docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。
这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件“污染” commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。
1. 安装node插件 npm global install markdown-toc 2.使用 文件内容 // README.md 文件 # 测试markdown-toc 生成目录 ### 目录1 目录1内容 ### 目录2 目录1内容 ### 目录3 目录1内容 ### 目录4 目录1内容 使用命令 # 在README.md文档中需要生成目录地方添加 # 使用命令 markdown-toc -i ./README.md 生成
每次 DDIA 读书会[1]之后,会把文字稿发在知乎[2]、博客[3]或者微信上。但是文字稿实在是又臭又长,这些平台似乎都不太是一个好的载体。而 GitHub Pages 使用 Jekyll[4] 渲染,但只支持寥寥几个免配置的主题,怎么说呢,就都挺丑的。
技术文档是程序员必备的参考书。那么如何高效地编写简洁优雅的技术文档,并快速发布到互联网上供他人阅览呢?
本人刚用 VuePress 写完一个 UI 框架的文档:https://zyqq.github.io/wheel 确实很好用且自带PWA,访问速度飞快。特此总结使用方法。
2017-03-1011:01:58 发表评论 913℃热度 Hexo-完全免费全平台搭建个人博客(1)-整体搭建 上一篇文章把 Hexo 博客整体搭建一遍了,能通过 xxxxx.github.io
Gitbook可以人每个人制作发布个人的电子书籍,并能最大程度上利用“群智”提高阅读品质和享受创作过程。
首先使用如下命令在自己的电脑上安装 docsify-cli 工具,方便后续的创建和预览自己的文档网站;
自从几年前开始在 GitHub 玩耍,接触到 Markdown 之后,就一发不可收拾,在各种文档编辑上,有条件用 Markdown 的尽量用,不能用的创造条件也要用——README、博客、公众号、接口文档等等全都是,比如当前这篇文章就是用 Markdown 编辑而成。
VuePress 会在 http://localhost:8080 启动一个热重载的开发服务器。
本篇介绍个人或企业在 GitHub 上发布一个 Python 项目需要了解和注意哪些内容
pages 用于构建Nuxt的路由及视图。Nuxt.js 框架读取该目录下所有的 .vue 文件并自动生成对应的路由配置。
新建一个名为你的用户名.github.io的仓库,这里,我的github用户名是Wasabi1234,那么就新建Wasabi1234.github.io的仓库,必须是你的用户名,其它名称无效,将来你的网站访问地址就是 http://Wasabi1234.github.io
本文就来介绍一下 Docsify[1] + Github Page 的方式,旨在快速搭建属于自己的文档网站
2021年, 国内各路论坛已经铺满屠龙宝刀点击就送的广告, 知乎这种传统的知识社区也完全沦陷, 无论是内容质量还是产品设计都大不如前
因为自己平时经常写博客,也有博客网站,所以 Leader 叫我做一个 CMS 的帮助中心的技术选型,CMS 的帮助中心的功能:是通过文章来教用户如何使用我们的项目。
http://img.blog.csdn.net/20140717215453576
网上关于动态文档生成工具有很多如:Docsify、 VuePress、Docute 、Hexo这些都是一些非常优秀的文档生成工具,本章主要介绍如何快速使用Docsify搭建一个快捷、轻量级的个人&团队文档。
创建config.js,这是vuepress的全局配置文件,大部分属性在这里设置。
在上一篇文章部署明星关系图谱那些事儿(GitHub Pages) 的最后,古柳讲到了GitHub Pages不仅可以用来搭个人博客,而且能单独部署静态网页(HTML/CSS/JS,而不涉及后端),鉴于自身在部署明星关系图谱时,查阅的几篇中文博客内容(可能没搜对关键词的缘故)都不太能解答我关于实操过程的困惑,最后还得感谢这篇简洁明了的英文文章:Use Github Static Pages to Host Your Front End Projects,助我成功部署,所以古柳也简单讲下实践步骤,希望能帮到有需要的人,对GitHub和Git熟悉的朋友直接拉到Git命令处即可,或者看原文也行。
从https://nodejs.org/en/下载并安装Nodejs,安装完后可通过终端命令node -v检验是否安装成功。
本文主要讲解第一种 gitbook-cli 命令行操作流程,其他两种见另外两篇教程.
VuePress 是一个静态网站生成器,包含由Vue驱动的主题系统和插件API,同时还包含一个为书写技术文档而优化的默认主题。此篇文章只介绍如何使用VuePress 搭建个人博客的部分。
在仓库根目录下创建 charts 目录,然后在该目录下开发所需要的 chart,如:
GitHub支持创建个人或组织以及项目这两种类型的网站。 本文章将向大家分享如何为项目、组织或个人创建一个GitHub Pages。 为项目创建GitHub Pages https://crazycodeboy.github.io/TakePhoto这是开源项目TakePhoto的GitHub Pages,大家可以先看一下效果。 你可以为你的项目创建一个GitHub Pages,大致分为以下步骤: 第一步:仓库设置 在GitHub上打开你的仓库首页,单击设置(Settings)页签 ![打开仓库设置页
在项目实践中,团队需要对用到的知识技术进行总结,即便于分享,也利于传承,而gitbook就是个不错的选择,使用gitbook-cli 对Markdown文档进行编译,生成静态文件,再通过web服务器(e.g. nginx)对外提供服务。
话不多说,我们来了解了解docsify,官方网站如下 https://docsify.js.org/#/zh-cn/?id=docsify 可以在linux,mac,Windows上来使用,今天演示用Windows作为演示,步骤都是一样的
VitePress 是 VuePress 的小弟弟,但是vitepress是在 Vite 上构建的。
VuePress 是静态站点生成框架之一,界面简介优雅,本文记录使用方法。 简介 VuePress 是尤雨溪(vue.js 框架作者)发布的一个全新的基于 vue 的静态网站生成器,实际上就是一个 vue 的 spa 应用,内置 webpack,可以用来写文档。 VuePress 有很多优点: 界面简洁优雅,不同于 Hexo,个人觉得更适合作为说明文档页 容易上手(半小时能搭好整个项目) 更好的兼容、扩展 Markdown 语法 响应式布局,PC端、手机端 Google Analytics 集成 支持
VitePress 是 VuePress 的下一代框架 ,是支持vue 3.0 的 web 网站框架。
安装 nodejs依赖,所有假设你已经安装好了node及npm(推荐cnpm) cnpm http://npm.taobao.org/ # npm install -g gitbook-cli 安装 ➜ ~ cnpm install -g gitbook-cli /usr/local/bin/gitbook -> /usr/local/lib/node_modules/gitbook-cli/bin/gitbook.js /usr/local/lib └── gitbook-cli@2.3.0 # 查看
因为饱受 GFM 和 Redcarpet 两种 Markdown 引擎生成 TOC 链接的差异的折磨,而我又不得不同时使用它们——博客基于 Jekyll 使用 Redcarpet(Update 2016/09/16: GitHub Pages 现在已经改为只支持 kramdown),而其它放在 GitHub 仓库里的文档使用 GFM,我决定为我常用的 Markdown 编辑器 Vim 做一款同时支持 GFM 和 Redcarpet 两种 TOC 链接风格的 Table of Contents 自动生成插件。
喜欢用 Markdown 写文档,那怎么把一个个 Markdown 文档组成在一起呢?
最近我重新试用了一下Gitbook,它是一个可以帮助我们快速创建结构化文档内容的工具。使用方法简单,入门门槛极低,任何人都可以很快掌握。
这是我编写的一个 Docfx 文档自动生成工具,只要写好 Markdown 文档,使用此工具可为目录、文件快速生成配置,然后直接使用 docfx 运行即可。
如果自己写的github爬虫没有特色或者没有很高的效率不如使用Github的API,数据获取可以来得快一些。
领取专属 10元无门槛券
手把手带您无忧上云