「小墨是前端」专注分享前端技术,推荐优秀的开源项目,展示Github、Gitee上的创意作品,带你深入前端底层,一起成长。
大家好,今天给大家推荐一款实现GitHub的Markdown风格的CSS库-github-markdown-css。用最少的CSS代码,实现了类Github的Markdown风格的样式。
一.简介
github-markdown-css,为我们提供一套基于Github的Markdown样式表,使得我们的Markdown文件能在浏览器中保持与Github一致的显示效果。无论你是在做网页内容展示,还是需要创建Markdown笔记,或者作为开发者需要编写清晰易懂的项目文档,github-markdown-css都是你的得力助手,它能让你的Markdown文档更具清晰度,更显专业性。
二.功能特点
- 对GitHub Markdown风格的呈现几乎完美,无论看到何处,它都能够精准复制GitHub布局的清晰度,为Markdown文档的阅读提供流畅快捷的体验。
- 使用起来非常简单,github-markdown-css为你准备好了专业的Github Markdown风格的CSS文件,只需将其连接至你的HTML文件,然后在HTML文件的合适位置填充你的Markdown内容,你的Markdown便可焕然一新。
- 如果你对的默认设置有所不满,或想要给它增添一些个性化的特点,你完全可以进行修改和调整,只需对CSS进行些轻微的改动,你就可以按自己的意愿来展现你独一无二的Markdown文档。
三.使用步骤
1,使用npm安装
npm install github-markdown-css
2,安装完成后,我们需要在页面中引入github-markdown.css文件。同时,在Markdown的容器元素上添加Class名为‘markdown-body’,并设置适当的宽度。GitHub使用的是980px的宽度和45px的内边距,移动端是15px的内边距。页面的基本设置如下:
3,在设置好样式之后,我们就可以在具备‘markdown-body’ Class的元素中,开始写入Markdown内容。
Hello World!
This is github-markdown-css tutorial!