初探 VuePress

前言

文档内容不多,就花半天时间翻译了一下,比较匆忙,有一些不是很理解的地方翻译的不是很通顺甚至有错误,欢迎大家指正。VuePress 中文

个人觉得最大的亮点就是:

  1. VuePress 文档是用 VuePress 写的
  2. markdown 文件可以内嵌 Vue 组件
  3. 借助 YAML 来作为驱动和配置文档
    ...

自己写自己的文档

今天一友人逛掘金的时候发现了这个好东西,遂推荐给我。


抱着玩一玩的心态,我就装了一个,反正不要钱,哈哈~

可是谁知道不玩不要紧,一玩就吃了闭门羹:


玩个屁

这我就不服气了,所以赶紧去 github 上提了个 issue,结果这破问题占据了 issue 榜上一整天,评论数还最多,最后的原因也找到了:Win10 的 Powershell 的锅。

不过当时我不知道啊,看这报错像是库本身有个地方出错了。出于猎奇的心,我 clone 了一份源码正准备调试...

咦,它这个 docs 文件夹?貌似就是一份 VuePress 的例子:


VuePress docs

要不?在这文件下跑一个 vuepress dev 命令试试?诶!还真跑起来了!

不过新的问题又随之而来:


侧边栏白屏

这真是让人头大,不过幸好现在也被尤大修复了:issue34

所以,我就抛弃了全局从 npm 拉下的包,转而用项目本身最新的代码来跑这份文档。


成功跑起

一切皆组件

文档里隐藏着一个惊天大秘密:


强大功能

目前 VuePress 支持的三种格式 html、md、vue 实际上最后都会转成 vue 组件!

也就是说形成了一个 markdown->html->vue 的管道。

小试牛刀

基于这个我最感兴趣的点,我做了一个小组件来体验一下:代码编辑组件。

很多时候,我们为了那么一两个功能或者 API 不得不重新拉个项目、装 npm 包,然后漫长的时光渡过了,环境配好,却已忘记自己要干啥。

所以,简单点,像 echarts 或者 G2 那样,在线调试,所见即所得,多好~

不过最终还是搞出个 demo:


demo

大家也看到了,还有很明显的 bug:不知道为啥被替换成繁字体聽的空格君,所以丢人的代码就先不放出来了...

YAML

就拿我刚刚实现的那个在线调试小组件来说,用的时候 markdown 文件里只需要这样写:

<CodeEditor :code="$page.frontmatter.code"/>

这个 $page.frontmatter.code 自然就是 markdown 里面定义的变量了,它使用的是 YAML 语法

JSON 原来是 YAML 的子集呢!

其他功能

VuePress 还有很多很棒的功能,比如一键部署(集成 git)、Algolia DocSearch 集成(借助 SSR 对 SEO 友好)等也是可圈可点的。只不过今天来不及玩了。

展望

今天的翻译也引起了我对文档国际化的思考,Vue 官方其实也在考虑这件事情,只不过要任重道远~

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,423评论 25 707
  • 本文为2016年11月9日,『前端之巅』微信群在线分享活动总结整理而成,转载请在文章开头处注明来自『前端之巅』公众...
    尾尾阅读 10,512评论 3 32
  • 耀眼星辰归于孤傲夜空 璀璨如斯,终归惨淡; 坚韧磐石归于无际大海 荡起波纹,终归沉底; 诸多琐事归于坚定...
    time有点坏阅读 228评论 0 1
  • 1. 今年母亲节的时候,我送了一个一千多元的智能手机给妈妈当礼物,那个她用了七、八年的按键手机被我强行淘汰了。 刚...
    苏小鹿lu阅读 2,677评论 45 85
  • 第一篇简书 还不是很清楚 简书的编写规范 作为iOS开发工程师,第一眼就喜欢上了简书,美观大方简洁 当然,以后写代...
    愁死我了阅读 219评论 0 0