写文档的工具非常多,但是作为程序员,大部人还是偏爱Markdown的,有时需要写一份开发文档,以供自己或者他人查看,那如何把 Markdown 文件转换成文档呢?
对于编程技术类的小程序来说,在文章会有很多代码,那么代码高亮就是一个文章显得很出色的需求了。代码高亮功能的实现,主要是依靠小程序里对富文本内容的解析。对于富文本解析,微慕小程序专业版以前采用的开源的wxParse组件,但这个组件不支持代码高亮,且二次开发的难度较大。从微慕小程序专业版v3.8.0开始引入了mp-html组件,该组件提供对代码高亮显示的支持。
如果我们是站长相关的网站博客,如果需要引用一些脚本代码的时候一般看到的都是代码高亮效果,这样的用户体验更好一些。我们要实现代码高亮的方法有很多中,比如WordPress也有代码高亮插件或者是手动实现CSS样式来实现代码高亮。在这篇文章中老蒋要分享的是Prism.js小工具可以实现页面的代码高亮效果。
在hexo框架中使用3-hexo主题时,会遇到这样一个问题:在markdown中嵌入html代码,这些嵌入的html代码无法正常显示。
打开 babel.config.js ,在module.exports中的plugins添加以下配置,如果原本没有plugins可以手动添加
昨天发了一篇介绍这个库:C# Blazor中显示Markdown文件,介绍怎么在Blazor中显示Markdown内容的文章,文章内的代码是没有高亮的,思来相去,还是要做好,于是百度到这篇文章.NET C# Blazor 服务端渲染Markdown,现在渲染效果如下:
最近yodu模板的用户要求我兼容typecho的Prismjs代码高亮插件,其实在《pjax(InstantClick) 常用的重载函数》中我就提到了Prismjs的pjax重载代码,但是经测试,还是有问题,于是今早又折腾了下,找到了方法。
mall项目是我去年写的SpringBoot实战电商项目,现在在Github上面已经有18k+star。去年12月份的时候,mall项目只有一些必要的说明文档和部署文档。mall项目涉及到的技术栈比较广泛,业务也比较复杂,却没有系统的学习教程。今年5月份的时候,我开始完善整套学习教程,目前已经更新了三十余篇。最近使用docsify搭建了一个小型的文档网站,希望大家能有更好的阅读体验。本文将介绍如何使用docsify来写开源项目文档。
prismjs漂亮的代码语法高亮插件 极致易用:引用 prism.css 和 prism.js,使用合适的 HTML5 标签(code.language-xxxx),搞定! 天生伶俐:语言的 CSS 类是可继承的,所以你只需定义一次就能应用到多个代码片段。 轻如鸿毛:代码压缩后只有 1.6KB。每添加一个语言平均增加 0.3-0.5KB,主题在 1KB 左右。 快如闪电:如果可能,支持通过 Web Workers 实现并行。 轻松扩展:定义新语言或扩展现有语法,或者新增功能都非常简单。 丰富样式:所有
leetcode-notebook[1] 的题解越来越多,原先选择 Gitbook[2] 构建解题本的弊端逐渐显现出来,每次补充一道题解重新 build 项目时居然要花上 30 秒左右……
你是否也见过像apollo这样的清爽干净的指南界面,是否觉得阅读起来赏心悦目?是否想过自己也弄一套类似的个人博客网站?作为程序员,积累技术文档还是很有必要的,只需要看完这篇,你也可以拥有属于自己的漂亮博客网站。
Next.js 已经成为 React 应用程序最重要的框架之一。它可以帮助开发人员在没有模板的情况下构建更好的服务器端渲染 React 应用程序。
最新版的Butterfly取消了原来设置在_config.yml里的默认CDN,导致不能快速替换掉现在极不稳定的jsDelivr CDN。本文的默认Butterfly版本为4.1.0。
Typecho是一款由国人开发的博客程序,它的特点是简洁小巧,扩展性强,并且内置支持Markdown语法写作,因而很受技术博客作者的欢迎。但是默认的Typecho没有自带语法高亮,要实现语法高亮就要使用Typecho相应的插件,而Typecho的插件安装和调试都比较难,这里就将介绍一种不使用插件来实现几乎所有语言的语法高亮的方法。
这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件“污染” commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。
根据官方说法,docsify是一个神奇的文档网站生成工具,也可以把它当做一个简易版的静态站点诸如Hexo、Hugo等。当然,它是专门针对文档的,忽然想到了程序员深恶痛绝的就是写API文档……
---- 博客地址 我个人博客的地址👉👉点击进入 开源项目地址 这是我一个开源的收藏网址的项目 项目地址👉👉点击进入,可以直接设置为浏览器主页或者桌面快捷方式进行使用,本人在用,长期维护。 完全
多级目录构建navbar、sidebar引用404问题:在构建多级文件目录的时候,针对多级文件夹下的md文件,其会相应加载同级目录下的navbar.md、sidebar.md文件,但这个时候由于navbar.md、sidebar.md文件存放在根目录或者是自定义指定的文件夹下,引用相对路径则会报404问题。针对上述情况,可以有如下调整方案:
Markdown 是一种轻量的标记语言,我们只需要写 md 格式文件,不必考虑文档的排版,被广泛用于博客写作,技术文档编写等,程序员们都热爱,但我们工作中除了写文档,有时候还需要汇报工作,技术分享等,需要用到 PPT,但设计 PPT 可能不是每个程序员所喜欢的,所以我们可以使用一个非常好用的工具 slidev, 可以使用 markdown 来制作演示文稿, 这个工具很多小伙伴都知道,尤大的分享就经常使用,其他类似的工具还有 Nodeppt、 marp 等,那么这类工具是如何实现的?
前面的文章讲到了基于语雀的在线文档编辑器的实现,在本文,将基于v-md-editor实现在线文档的编辑。
虽然也有一些优秀的写代码 App 可供程序员使用,但本着能不花钱就不花钱的原则,还是可以去找一些开源软件。
docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。
简介 一个神奇的文档网站生成器。 简单而轻便(〜18kB压缩) 没有静态构建的HTML文件 多个主题 快速开始 建议docsify-cli全局安装,这有助于本地初始化和预览网站。 npm i docsify-cli -g 初始化 如果在根目录中编写文档 docsify init ./ 写作内容 在之后init完成后,你可以看到在文件列表./根目录。 index.html 作为入口文件 README.md 作为主页 .nojekyll 防止GitHub页面忽略以下划线开头的文件 您可以轻松更新文档./READ
虽然也有一些优秀的写代码App可供程序员使用,但本着能不花钱就不花钱的原则,还是可以去找一些开源软件。
* https://blog.csdn.net/qq_38504396/article/details/79835475 *
Docsify是一款开源的文档生成工具,目前在Github上已有21K+Star。Docsify可以快速帮你生成文档网站,不同于VuePrese和Hexo的地方是它不会生成静态的.html文件,所有转换工作都是在运行时。
The pluggable linting utility for JavaScript and JSX
优点:使用 markdown 编写,docsify 作为支撑。快速高效,若搭载搜索功能,功能较为完善。且可部署在内网环境。
随着浏览器不断的升级改进,CSS和JavaScript之间的界限越来越模糊。本来它们是负责着完全不同的功能,但最终,它们都属于网页前端技术,它们需要相互密切的合作。我们的网页中都有.js文件和.css文件,但这并不意味着CSS和js是独立不能交互的。下面要讲的这五种JavaScript和CSS共同合作的方法你也许未必知道!
在Hexo的根目錄source文件夾下創立一個self文件夾,在self文件夾創建一個Kimbiedark.css文件
CodeHighlighter插件是一款基于prismjs的代码语法高亮typecho插件,支持众多常见的代码语言高亮显示,官方提供8种代码高亮风格自由切换,支持显示代码语言类型、行号,以及支持复制代码到剪切板功能。
回到上一篇我讲的不变前端中,我在文章中明显的指出了,前端的变化会有一个分界线,在这个分界线之前,前端有一个最大的困境,就是:
这是一篇基于Gitee搭建个人网站的保姆级教程。从零到一。如果你想基于云服务器搭建,我以前写过一篇菜鸟篇。
首先使用如下命令在自己的电脑上安装 docsify-cli 工具,方便后续的创建和预览自己的文档网站;
docsify 终于算是弄完了,简单记录下。然后发现一个问题,相比 Hexo,Hugo 这些页面加载很慢,鱼与熊掌不可兼得,运行时生成只能这样了。
pjax(InstantClick)一般需要重载的函数,希望这篇文章能让大家少浪费点时间
CSS方法实现的优缺点 优点: 简单,高效,性能十足,即使代码变来变去布局也OK。
当你在局部刷新肯定是把html在通过ID定位覆盖,你只要把代码高亮的执行直接写在这个局部刷新的html下面即可
1. 让 pre 按钮在Django 后台 ckeditor 富文本编辑器中显示出来,ckeditor 的 config.js 文件里添加插件:codesnippet
最近给博客加入了代码高亮的功能,发现直接访问文章页面有代码高亮 但是进首页再点击文章页后,代码高亮消失,刷新才行 发现是Pjax的问题,解决后就在此做个记录并分享
之前用wordpress的时候,从来没遇到过这种问题。高亮代码后,不管怎么看都是高亮。自从用上typecho,发现有些主题直接访问文章页面有高亮代码;但是,进首页再点击文章页后,代码高亮消失,刷新才行。
docsify 是一个动态生成文档网站的工具,可以将.md 文件以 wiki 的形式展示给读者,可以用于制作技术文档、用户手册、wiki 等,快速以网站形式构建、发布软件的API手册或用户说明文档,方便用户使用你的软件,达到快速传播作用。可以部署于主机、VPS、Github、静态云存储(例如阿里云 OSS)。
建网站本身是一个很大的工程,涉及前端页面的搭建,网站数据的存储,还要购置服务器资源,甚至是后期的维护,过程相当繁琐。
我的CN華少博客建设也有一段时间了,这段时间想去更新一下文章,突然发现原来的源码被我不知道弄到哪里去了,于是乎我又准备重新建一个项目,并在其基础上更换一套新的模板,并与Typore中的.md文件进行使用尝试,近期这几篇可能就是这个系列来进行了。 另之前开设的SSO统一身份认证近期没有再进行更新,后续会对其进行补充,请大家持续关注。
MutationObserver 是一个内建对象,它观察 DOM 元素,并在检测到更改时触发回调。
如何使用代码高亮插件,之前的教程中已经写过了,在这里我不再说明,接下来给大家展示下代码高亮插件所支持的主题风格有哪些以及各自的展示效果。
主要对 W3C 工作小组提出的各个草案和标准做了一些解读,各个草案的时间点,以及关注的内容等。
领取专属 10元无门槛券
手把手带您无忧上云