Mark down学习日记

最新推荐文章于 2024-06-01 10:00:10 发布

小樊开始学c

最新推荐文章于 2024-06-01 10:00:10 发布

阅读量273

点赞数

分类专栏：笔记

本文链接：https://blog.csdn.net/m0_56002666/article/details/121972044

版权

Markdown是一种轻量级标记语言，常用于编写技术文档。本文档详细介绍了Markdown的入门、语法，包括标题、段落、代码、图片等，并提到了Markdown在技术文档中的广泛应用，如Read the Docs、MkDocs等工具。

摘要由CSDN通过智能技术生成

Time：2021.12.16

Place：Shenyang northeastern univercity

Markdown学习

入门教程

工作原理

在使用 Markdown 格式书写时，文本内容存储在带有 .md 或 .markdown 扩展名的纯文本文件中。那然后呢？你的 Markdown 格式的文件如何转换为 HTML 或可打印的文档呢？

简单来说，你需要一个能够处理 Markdown 文件的 Markdown 应用程序。有许多应用程序可供选择，从简单的脚本到类似于 Microsoft Word 的桌面应用程序。尽管它们在视觉上有所不同，但所有应用程序都执行相同的操作。像 在线 Markdown 编辑器 一样，它们都是将 Markdown 格式的文本转换为 HTML，以便可以在 Web 浏览器中显示。

Markdown 应用程序使用一种称为 Markdown 处理器（也通常称为“解析器”或“实现”）的东西将获取到的 Markdown 格式的文本输出为 HTML 格式。此时，可以在 Web 浏览器中查看你的文档，或者将其与样式表组合并打印。你可以在下图看到此过程的直观表示。

总而言之，这是一个四步的过程：

使用文本编辑器或 Markdown 专用的应用程序创建 Markdown 文件。该文件应带有 .md 或.markdown 扩展名。
在 Markdown 应用程序 中打开 Markdown 文件。
使用 Markdown 应用程序 将 Markdown 文件转换为 HTML 文档。
在 web 浏览器中查看 HTML 文件，或使用 Markdown 应用程序将其转换为其他文件格式，例如 PDF。

文档

Markdown 非常适合技术文档。像 GitHub 这样的公司越来越多地转向使用 Markdown 来创建其文档了，请查看此博文以了解如何将 Markdown 格式的文档迁移到 [Jekyll]。如果你是为产品或服务编写文档，请试试以下的便捷工具：
Read the Docs 可以将你所开源的 Markdown 文件生成文档网站。只需将你的 GitHub 仓库连接到他们的服务，然后你就可以将内容推送到该仓库中，Read the Docs 会完成其余的工作。他们还为商业实体提供服务。
[MkDocs] 是一个快速、简单的静态站点生成器，专门用于构建项目文档。文档源文件使用 Markdown 编写，并使用一个 YAML 配置文件进行配置。MkDocs 有多个内置主题，包括移植自 Read the Docs 的文档主题。最新的一个主题是 MkDocs Material。
[Docusaurus] 是一个静态网站生成器，专门用于创建文档网站。它支持翻译、搜索和版本控制。
VuePress 是基于 Vue 构建的静态站点生成器，并针对编写技术文档进行了优化。
[Jekyll] 前面已经提到过它了，但它也是将 Markdown 文件生成文档网站的一个不错的选择。如果你选择 Jekyll，请务必试试 Jekyll 文档主题