🥔Potato文档之旅:轻量级标记语言(.md)
👏开场白
大家好我是玲,今天分享Markdown轻量级标记语言在文档中扮演重要角色,他们属于易读易写的纯文本格式编写文档,通过使用 Markdown 的 来创建表格、代码块、自动链接等,让你的 Markdown 文档更加出色。
♻网站分享
深入学习网站:
markdown.com.cn/
工欲善其事,必先利其器。我们想要更方便编辑文档,一定先要先做好准备,创造条件。
👉文档用途(日常记录)
Markdown 是做笔记、为网站创建内容以及生成可打印文档的快速、简便的方法。Markdown 的场景用途:网站、文件资料、笔记、书籍、演示文稿、邮件和文档。
-
网站:Markdown 是为 web 而设计的,如果你是 WordPress 博主,你可以使用 Jetpack 插件 (opens new window)实现对 Markdown 的支持。
-
文件资料:Markdown 并不具备像 Microsoft Word 这样的文字处理程序的所有功能,但是对于创建基本文件(例如作业和信件)来说已经足够了。
- 现代编辑器
VSCode / Atom - 传统编辑器
Vim / Emacs / Sublime Text / Notepad++ - IDE 自带编辑器
IntelliJ IDEA / Android Studio / WebStorm - 专用编辑器
Ulysses / Mou / 妙言 / Markpad - 在线编辑器
各种支持 Markdown 的网站都提供了在线 Markdown 编辑器
- 现代编辑器
-
笔记:在几乎所有方面,Markdown 都是记笔记的理想语法。Evernote (opens new window)和 OneNote (opens new window)目前都不支持 Markdown。
- [Simplenote] 是适用于所有平台的免费、简单的笔记应用程序。
- [Notable] 是可以在各种平台上运行的笔记应用程序。
- [Bear] 是适用于 Mac 和 iOS 设备的类似 Evernote 的应用程序。默认情况下,它并不专门针对 Markdown 的,但是你可以启用 Markdown 兼容模式。
- [Boostnote] 自称是“专为程序员设计的开源笔记应用程序”。
-
书籍:
想要自行出版小说?请试试 Leanpub (opens new window),该服务可将你的 Markdown 格式的文件转换为电子书。Leanpub 以 PDF、EPUB 和 MOBI 文件格式输出你的图书。 -
演示文稿:
Markdown 格式的文件转换成演示文稿。在 Markdown 中创建演示文稿需要一点时间来适应,但是一旦你掌握了它,你就能体会到比使用 PowerPoint 或 Keynote 之类的应用程序更快、更容易。 -
邮件:
Markdown 编写电子邮件的简便方法:[Markdown Here] 是一个免费、开源的浏览器扩展程序,可将 Markdown 格式的文本转换为可用于发送的 HTML。 -
文档 :
便捷工具:- Read the Docs (opens new window)可以将你所开源的 Markdown 文件生成文档网站。只需将你的 GitHub 仓库连接到他们的服务,然后你就可以将内容推送到该仓库中,Read the Docs 会完成其余的工作。他们还为 商业实体提供服务 (opens new window)。
- [MkDocs] 是一个快速、简单的静态站点生成器,专门用于构建项目文档。文档源文件使用 Markdown 编写,并使用一个 YAML 配置文件进行配置。MkDocs 有多个 内置主题 (opens new window),包括移植自 Read the Docs (opens new window)的文档主题。最新的一个主题是 MkDocs Material (opens new window)。
- [Docusaurus] 是一个静态网站生成器,专门用于创建文档网站。它支持翻译、搜索和版本控制。
- VuePress (opens new window)是基于 Vue (opens new window)构建的静态站点生成器,并针对编写技术文档进行了优化。
- [Jekyll] 前面已经提到过它了,但它也是将 Markdown 文件生成文档网站的一个不错的选择。如果你选择 Jekyll,请务必试试 Jekyll 文档主题 (opens new window)。
👀效果展示
- 保持每天开心!
- 骑单车出门!
- 我爱洗澡
这是我的删除线,十个不到的标记符号,却能让人优雅地沉浸式记录,专注内容而不是纠结排版,达到「心中无尘,码字入神」的境界。
🍗注意事项
Markdown语法与html语法有一定区别:\
html语法
Markdown语法
注意
# :
不同的 Markdown 应用程序处理 # 和标题之间的空格方式并不一致。为了兼容考虑,请用一个空格在 # 和标题之间进行分隔。
🌟灵感来源
学习过程中,看见Markdown语法与html语法不同,试着用Markdown语法在掘金上编写文章,对此很感兴趣,接下来文档编写会达到「心中无尘,码字入神」的境界!感谢您看完这篇文章,网站的一砖一瓦的贡献,会码出自己的小小世界!