首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >文档标题的Markdown标记

文档标题的Markdown标记
EN

Stack Overflow用户
提问于 2013-06-14 06:00:29
回答 6查看 68.1K关注 0票数 79

有没有办法在Markdown文档中指明文档标题?

我已经开始使用带有Sublime Text的Markdown来准备我的许多个人和业务文档。例如,我经常希望有一种类似于Word中的标题样式的“顶级”标题。所以,举个例子:

代码语言:javascript
复制
### Things to Do ###

At Home
=======
*    Mow the cat
*    Feed the lawn

At the Office
=============
*    Learn Markdown
*    Use Big-O notation in a clever way

但是### Things to Do ###这条线并不受Markdown的尊重,我也不知道还有什么其他的选择。有吗?

我可以对标题使用标题1样式,然后对其余部分使用标题2,但是如果我需要更深的标题嵌套,我很快就会用完深度。毕竟,标题本质上不是标题。例如,如果Markdown-to-HTML解析器使用页面<title>的标题以及页面顶部的页眉如Word标题,那就更好了。

EN

回答 6

Stack Overflow用户

回答已采纳

发布于 2013-06-14 06:17:11

Markdown设计的一个有趣之处在于明确允许使用HTML。HTML5添加了语义页面部分,包括和,这可能非常适合您的页面标题。

例如:

代码语言:javascript
复制
<header>
Things to Do
============
</header>
<main>
At Home
=======
*    Mow the cat
*    Feed the lawn

At the Office
=============
*    Learn Markdown
*    Use Big-O notation in a clever way
</main>

如果您希望排除HTML,则可能需要使用Atx样式的标题,以便获得两个以上的层次结构级别。

例如:

代码语言:javascript
复制
# Things to Do

## At Home
*    Mow the cat
*    Feed the lawn

## At the Office
### Morning
*    Learn Markdown
*    Use Big-O notation in a clever way
### Afternoon
*    Read e-mails
*    Scrutinize LOLcats
票数 25
EN

Stack Overflow用户

发布于 2015-06-11 08:16:21

如果你特别提到pandoc的降价,最简单的方法是使用'%',例如

代码语言:javascript
复制
% Document Title

# Header 1

content

## Header 2

## Header 2

有关http://pandoc.org/README.html#metadata-blocks标记的更多信息,请参见pandoc。

票数 51
EN

Stack Overflow用户

发布于 2018-09-09 00:32:33

我在Markdown中撰写书籍和研究论文,我只在Markdown中发布GitHub,而Markdown中的HTML标签在GitHub上不起作用,所以我使用以下约定:

代码语言:javascript
复制
Document Title
==============

***This is a subtitle***

**Author:** *Me*

# Chapter One: Overview

Do you know the way?

---

# Chapter Two: Foo

Foo is the way...

---

它最终看起来像这样:

文档标题

这是一个副标题

作者: Me

第一章:概述

你认识路吗?

第二章: Foo

Foo是一种..。

我使用---来分隔章节,因为它看起来很好,并且有助于在文本中找到章节。然而,当Markdown文档变得很大时,这确实会带来一个问题,在这种情况下,Markdown预览窗口会在您每次输入时冻结,因为它会刷新,或者Grammarly开始出现bug并长时间使用REALLY。这是使用=== H1标题格式的理由,因为当文档变得很大时,您需要将其拆分,在这种情况下,使用该格式是很好的:

代码语言:javascript
复制
Document Title
==============

***This is a subtitle***

**Author:** *Me*

[<< Previous Chapter](URL) | [Content Table](URL) | [Next Chapter >>](URL)

---

# Chapter Two: Foo

Foo is the way...

---

[<< Previous Chapter](URL) | [Content Table](URL) | [Next Chapter >> ](URL)

然后看起来是这样的:

文档标题

这是一个副标题

作者: Me

<< Previous Chapter | Content Table | Next Chapter >>

第二章: Foo

Foo是一种..。

<< Previous Chapter | Content Table | Next Chapter >>

我也放弃了使用Wiki文件名作为标题,因为它不允许使用连字符连接的单词,这会弄乱我的章节标题,所以我切换到所有以章节索引01_chapter_name.md02_chapter_name-with-hyphens.md,...开头的小写文件名。使用=== H1标题格式,并将我的Markdown书籍移动到主存储库中,这样我就可以使用问题驱动开发和GitHub问题和项目,每个章节一个项目,这样我就可以记住所有要做的事情,并通过积压。

票数 31
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/17097894

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档