markdown 语法

  • teedoc
  • markdown
  • 语法

本文是使用Markdown编写的文档，使用teedoc生成的页面效果， Markdown文件见这里

Markdown 基本文件内容格式

需要先在site_config.json中确认有markdown解析插件启用了，比如teedoc-plugin-markdown-parser。

在config.json对应的目录下建立文件夹或者文件， 比如get_started/zh/syntax/syntax_markdown.md (README.md最终会生成index.html)， 然后编写内容：

Markdown 文件头

添加一个头

---
title: markdown 语法
tags: teedoc, markdown, 语法
keywords: teedoc, markdown, 语法
desc: teedoc 的 markdown 语法介绍和实例
---

通过这些键值来设置文章信息：

  • title: 文章的标题
  • keywords: 关键词，多个关键词用英文逗号, 隔开，会被添加到html头中，方便搜索引擎爬取，不会显示到页面
  • desc: 页面描述，会被添加到html头中，方便搜索引擎爬取
  • tags： 文章标签，会显示到页面
  • id: 页面id， 会被添加到html标签中，比如<html id="zh_readme">...</html>, 可以不设置，会覆盖config.json中的设置
  • class: 页面class,多个用英文逗号,隔开，可以不设置，会覆盖config.json中的设置。比如可以通过设置这个值来达到设置特定页面的css样式

Markdown 文件内容

内容就是使用Markdown语法进行编写，因为标题会被转成<h1>标签，所以内容中建议从二级标题开始，这样一个页面只有一个<h1>标签，方便搜索引擎爬取，比如

---
title: teedoc
keywords: teedoc, markdown, jupyter notebook, html, 文档生成, 替代gitbook, 网站生成, 静态网站
desc: teedoc， 将 markdown 或者 jupyter notbook 转换成 html 静态网页
id: zh_readme
class: zh_readme
---


## 标题一

内容。。。

## 标题二

内容。。。

一级标题（#）最好不要使用， 因为上面的title会自动生成一个一级标题（<h1>标签），一个页面最好只有一个一级标题，方便搜索引擎爬取收录

keywords 是生成的 html 页面的 keywords， 不会显示到页面，主要提供给搜索引擎使用
desc 是生成的 html 页面的 description， 不会显示到页面，主要提供给搜索引擎使用
tags 是给文章的标签，会显示在页面

二级标题

三级标题

四级标题

四级标题2

四级标题3

五级标题
六级标题

最多 6 级标题

链接

相对路径， index.html 文件: ../README.md， 会自动转换成index.html

相对路径，.html 文件： ./syntax_markdown.md， 会转成文档的 .html 结尾的链接

绝对路径， http 文件： https://。。。/beginner.ipynb，原链接，不会修改

相对路径，.html 文件： ./syntax_jupyter.ipynb， 会转成文档的 .html 结尾的链接

列表

列表项:

  • 包子
  • 馒头
  • 茶叶蛋
  • aaaaaaa

    • 二级列表

    • 二级列表

    • 二级列表

  • bbbbbb

code

这是一段行内代码print("hello")，或者强调teedoc

print("hello")

print("world")

#include "stdio.h"

int main()
{
    printf("hello world");
}

注释(引用块)

下面是一段注释

这里是一段注释 (<blockquote></blockquote>)
这是注释的第二行

# 这里是注释里面的代码段
print("hello")

注释

注释嵌套
注释嵌套

警告

下面是一段警告信息

这是一段警告信息(<blockquote class="spoiler"></blockquote>)

图片

要显示这张图片，需要在site_config.json中设置route键值

这是一张图片
这是一张图片

这是一张图片这是一张图片

视频

<video src="https://****.com/***.mp4" controls="controls" preload="auto">your brower not support play video</video>

这里没有放视频， 所以是空白, 放入正确的视频就可以播放了

iframe 嵌入网页

引用标记

我能干饭我自豪。1

这会在文章末尾进行注解

划线

我是天神打工人啊

表格

Header 1 Header 2
Cell 1 Cell 2 link
Cell 3 Cell 4

任务列表

  • 任务1
  • 任务2
  • 任务3
  • 任务4

  1. 老子说道 ↩