首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

团队技术文档构建利器vuepress上手实践

3.1.2 导航栏(navbar) themeConfig.nav 导航栏包括 左侧页面标题、搜索框、导航栏链接、多语言支持、仓库链接,支持下拉分组菜单,还支持全局或单页面禁用。...3.1.3 侧边栏(sidebar) themeConfig.sidebar 侧边栏一般用于文档目录索引,可以直接在 config.js 配置链接数组,也页面配置 sidebar:auto 自动生成侧边栏目录...侧边栏还支持以下更加细节设置: 设置嵌套层数 是否展开所有 标题链接是否激活(禁用可以懒加载提升性能) 分组 侧边栏分页面定制 禁用 3.1.4 搜索框(search box) themeConfig.search... Markdown 中使用 Vue .vuepress/components 所有 *.vue 文件都会自动注册为全局异步组件,如: . └─ .vuepress └─ components...module.exports = { base: '/test/' } 可以项目中创建 deploy.sh 文件,方便在持续集成设置每次 push 代码时自动运行脚本。 #!

1.3K20

团队技术文档构建利器vuepress上手实践

3.1.2 导航栏(navbar) themeConfig.nav 导航栏包括 左侧页面标题、搜索框、导航栏链接、多语言支持、仓库链接,支持下拉分组菜单,还支持全局或单页面禁用。...3.1.3 侧边栏(sidebar) themeConfig.sidebar 侧边栏一般用于文档目录索引,可以直接在 config.js 配置链接数组,也页面配置 sidebar:auto 自动生成侧边栏目录...侧边栏还支持以下更加细节设置: 设置嵌套层数 是否展开所有 标题链接是否激活(禁用可以懒加载提升性能) 分组 侧边栏分页面定制 禁用 3.1.4 搜索框(search box) themeConfig.search... Markdown 中使用 Vue .vuepress/components 所有 *.vue 文件都会自动注册为全局异步组件,如: . └─ .vuepress └─ components...module.exports = { base: '/test/' } 可以项目中创建 deploy.sh 文件,方便在持续集成设置每次 push 代码时自动运行脚本。 #!

2.4K94
您找到你想要的搜索结果了吗?
是的
没有找到

开发工具总结(15)之Vuepress制作文档并发布到GitHub

6.markdown使用: markdown文件开头加入以下两个css链接,然后再去写katex语法即可。...当用户通过滚动查看页面的不同部分时,嵌套标题链接和 URL Hash 值会实时更新,这个行为可以通过以下配置来禁用:(一般用默认可以,不做修改。).../MyDocs", // 是否编辑链接 editLinks: true, // 编辑链接文字 editLinkText: " GitHub 上编辑此页", /...(8) Git 仓库和编辑链接 当你提供了 themeConfig.repo 选项,将会自动每个页面的导航栏生成生成一个 GitHub 链接,以及页面的底部生成一个 "Edit this page"...: '/manifest.json' }], ] } 可以通过 YAML front matter 来设置是否指定页面的编辑链接

3.8K50

利用PicGo和SM.MS图床工具实现Markdown(Typora)图片脱离本地路径

利用PicGo和SM.MS图床工具实现Markdown(Typora)图片脱离本地路径 1.前言: 现代技术写作图像在传达信息和概念方面扮演着不可或缺角色。...本文将深入探讨如何借助这两个工具,让你Markdown文档图片告别本地束缚,轻松实现图像云端管理。...Typora Typora是一款所见即所得Markdown文本编辑工具——在你输入相应标记符号后,系统会自动对所标记文本进行渲染,设置成相应格式。...Markdown支持: Typora支持Markdown语法,用户可以使用简单文本标记来进行格式化,如标题、列表、链接等。编辑过程Markdown源码和渲染效果同时可见。...配置Typora 打开Typora,偏好设置图像按照下面配置完成,上面上传图片也可以选择其他,根据自己需求;最下面的PicGo路径选择自己本地安装路径。

18810

Markdown高级教程

推荐 VS Code 编辑 Markdown 原因有两个: 1.不用再安装别其余应用2.更好 Gitee 或者 GitHub 渲染,因为一些网站或者开发平台为了安全考虑不会支持太多渲染。...[图片alt](图片链接 "图片 title") 注意 如果要给图片增加链接,请将图像 Markdown方括号,然后将链接添加在圆括号 转义字符语 要显示原本用于格式化 Markdown 文档字符...,请在字符前面添加反斜杠字符 \ 需要特别注意是, Markdown 块级元素和内联元素, < 和 & 两个符号都会被自动转换成 HTML 实体,这项特性让你可以很容易地用 Markdown 写...例如,您可以添加链接,代码(仅反引号(`)单词或短语,而不是代码块)和强调 我们不能添加标题,块引用,列表,水平规则,图像或 HTML 标签 代码块 创建代码块 我们可以通过把行缩进四个空格或一个制表符来创建代码块...Markdown渲染到网站时,不同浏览器、网站所能支持表情也不同,也需要根据实际效果确认 完后总结了一下几乎所有的 emoji 表情,放置GitHub 仓库,大家可以按需下载看一下 GitHub

1.6K10

Hexo安装并使用Butterfly主题

需要添加友情链接可以Butterfly.yml配置 可在友情链接上写上自己个人资料,方便其他人添加。...优先选择自动节选。 butterfly.yml里可以开启auto_excerpt选项,你文章将会在自动截取部分显示主页。(默认显示150个字)。...页顶部图可以Butterfly.yml设置archive_img 其他page页顶部图可以各自md页面设置front-mattertop_img 页面如果没有设置各自top_img,则会显示...` 或者 `hexo-renderer-marked` 等hexomarkdown渲染器 # 你可以在你package.json里找到hexomarkdwon渲染器,并将其卸载 npm un hexo-renderer-marked...比如你想要禁用掉 KaTeX 命令行上输出宂长警告信息,你可以根目录 _config.yml 中使用下面的配置将 strict 设置为 false: markdown_it_plus: plugins

5K40

6 个新功能、39 个增强功能!JupyterLab 新版本更新!

Markdown 图表 与 GitHub-Flavoured Markdown 相匹配,JupyterLab 和 Notebook 现在支持mermaid[3]图表。...建议可以输入时调用,也可以使用可配置快捷键(默认为 Alt + \)手动调用。当鼠标悬停在幽灵建议上时,默认键盘快捷键会显示小部件。...从跟踪记录打开文件 现在,代码错误跟踪检测到文件路径已经转换为链接。...当文件位于Jupyter根目录时,这些链接会打开相应文件以进行编辑;如果文件根目录之外,且当前内核支持调试器,这些链接将以只读模式打开预览。...插件管理器 现在用户可以通过新插件管理器用户界面实现对单个插件禁用或启用。

23110

Markdown也有xss

作者:惊鸿一瞥最是珍贵 前言 最近我测试一个web网站时候发现,我可以通过markdown编辑器和渲染包来触发跨站点脚本(XSS)漏洞。...我测试Web应用程序,我知道触发XSS不是很容易一件事。它是一个Angular应用程序,默认情况下会清除页面上渲染所有内容。...再探Markdown Markdown另一个例子是链接,它语法与图像相同,但是没有前缀'!'。...如果我们可以创建一个图像并将脚本设置为加载图像时运行,那么响应页面看起来就像预期那样,我们攻击代码将在后台运行。 再进一步! 回到markdown图像语法 !...很重要一点是: markdown如何渲染为HTML,因markdow不同而异。 Markdown中将JavaScript注入图像代码最佳方式 ![Uh oh...]

2.5K40

GitHub 12个实用技巧

可以直接复制一个图片到剪贴板,当你粘贴时候,你图片将会自动上传到云,然后展示页面上。 #3 美化代码 如果你想编写一个代码块,以三个反引号开头,GitHub会尝试猜测你用什么语言。...(顺便说下,gist,如果你gist文件后缀名是.jsx, 将自动获得JSX语法高亮) 这是所有支持语法列表. #4 PRs巧妙关闭issues 如果你创建了一个pull request来修复问题单...你可以PR描述写fixes #234。 当合并PR时候,会自动关闭那个issue。是不是很方便:) 了解更多。 #5 链接到评论 是否想要链接到某个特定评论?...点击评论框用户名旁边时间,就可以得到链接了。 ? #6 链接到代码 是否想要链接到一行特定代码? 打开一个文件,点击代码左边行号,或者按住shift选择多行。 分享这个URL,可以链接到这些代码。...我建议是文本写在markdown文件,然后存到你仓库。接着在前端写一个组件来请求文件然后渲染

1.2K20

公司新来一个同事,把 Typora 玩得炉火纯青!太强悍了

图片插入 插入图片除了使用插入语句外,还可以: ctrl+C/V 将网络图片、剪贴板图片复制到文档 拖动本地图片到文档 Typora 会自动帮你插入符合 Markdown 语法图片语句,并给它添加...需要说明是, Markdown 语法,换行(line break)与换段是不同,且换行分为软换行和硬换行。 软换行: Typora ,你可以通过shift+enter完成一次软换行。...你可以「文件 - 偏好设置 - 编辑器 - 默认换行符」对此进行切换。 支持emoji 表情 Typora ,你可以用 :emoji: 形式来打出 emoji,软件会自动给出图形提示。...总不能自己一张张上传,然后复制网络连接吧,也不是不可以 下面介绍两种方式实现自动上传。...,便于管理: 最后再统一上传: 四、注意事项 自定义HTML图片无法上传,只有通过Typora创建图像可以

4K10

再不用怕Markdown绘图了,GitHub官方支持Mermaid图表绘制工具

可以将其看做是 Markdown 一个插件。 截至目前,用户想要在 GitHub Markdown 文件包含图片 / 图表,唯一做法是通过嵌入图像来实现。...Knut Sveidqvist 新一年,GitHub 开发者关系总监 Martin Woodward 官方博客表示,从现在开始,用户可以通过 GitHub 体验到一项原生功能 —— 支持基于 JavaScript...现在用户通过使用 Mermaid 语法就可以创建内联图,例如: 上面的原始代码块渲染后, Markdown 显示如图: Mermaid 如何工作?...这样做具有以下优点: 将库 offload 到外部服务时,可以减少 JavaScript 有效负荷; 异步渲染图表有助于消除开销; 用户提供内容被锁定在 iframe ,这样不会在加载图表 GitHub...想了解更多有关 Mermaid 语法信息,请参考:http://mermaid-js.github.io/mermaid/#/ 参考链接: https://github.blog/2022-02-14

1.4K20

Typora+PicGo+Gitee搭建博客写作环境

Typora:它是一款轻便简洁Markdown编辑器,支持即时渲染技术,即所写立刻所见,少了排版时间,专注于文章内容编辑。...PicGo:它是一个用于快速上传图片并获取图片 URL 链接工具,支持多种图库。 Gitee:目前中国最大代码托管工具,除了代码,还可以用作图片存储。...1.2 PicGo 所谓图床工具,就是自动把本地图片转换成链接一款工具,网络上有很多图床工具,就目前使用种类而言,PicGo 算得上一款比较优秀图床工具。...它是一款用 Electron-vue 开发软件,可以支持微博,七牛云,腾讯云COS,GitHub,阿里云OSS,SM.MS,imgur 等7种常用图床,功能强大,简单易用。...3、Typora接入图床 有了前面的工作后,就可以Typora接入图床了 Typora左上角选择文件--->偏好设置--->图像, 按照下图进行配置 image-20210803234944722

1.9K00

8条github使用小技巧

2 github日常使用小技巧 2.1 markdown绘制在线地图 github支持使用markdown编写文档或内容利用特殊语法插入geoJSON或topoJSON数据,从而直接渲染交互式在线地图...令图片根据主题自动切换 github在其markdown语法,添加了可以随着用户对网站主题切换,而自动变换到相应图片地址功能,具体用法可参考(https://github.blog/changelog...,回到github编辑窗口中选中某段文字后粘贴,就会自动快捷生成以这段文字为显示内容链接: 2.4 快捷生成引用块、有序列表及无序列表   选中目标内容后,按下快捷键ctrl+shift+.可以快速生成引用块...;按下快捷键ctrl+shift+7可以快速生成有序列表;按下快捷键ctrl+shift+8可以快速生成无序列表: 2.5 为文档生成脚注   我们可以markdown文档利用[^序号]语法完成脚注内容插入...,创建出带有状态风格引用块,从而使得我们文档内容更加别致,大家也可以(https://github.com/github/feedback/discussions/16925)关注其最新消息:

37320

提升Github使用体验8个技巧

2 github日常使用小技巧 2.1 markdown绘制在线地图 github支持使用markdown编写文档或内容利用特殊语法插入geoJSON或topoJSON数据,从而直接渲染交互式在线地图...令图片根据主题自动切换 github在其markdown语法,添加了可以随着用户对网站主题切换,而自动变换到相应图片地址功能,具体用法可参考(https://github.blog/changelog...,回到github编辑窗口中选中某段文字后粘贴,就会自动快捷生成以这段文字为显示内容链接: 2.4 快捷生成引用块、有序列表及无序列表 选中目标内容后,按下快捷键ctrl+shift+.可以快速生成引用块...;按下快捷键ctrl+shift+7可以快速生成有序列表;按下快捷键ctrl+shift+8可以快速生成无序列表: 2.5 为文档生成脚注 我们可以markdown文档利用[^序号]语法完成脚注内容插入...,创建出带有状态风格引用块,从而使得我们文档内容更加别致,大家也可以(https://github.com/github/feedback/discussions/16925)关注其最新消息:

47220
领券