文档标题的标记标签

在 Markdown 文档中是否没有指示文档标题的方法？

我已经开始使用用崇高文本 Markdown 来准备我的许多个人和业务文档。例如，我经常希望有一种类似于 Word 中的 Title 样式的“顶级”标题。例如:

### 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 作为页面 <title>的标题，以及使用 la Word 标题作为页面顶部的标题，那就太好了。

85962 次浏览
小开
最佳答案

One of the interesting points of Markdown's design is that HTML is explicitly allowed. HTML5 added semantic page sections including <header> and <main>, which may be a good fit for your page title.

For example:

<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>

If excluding HTML is preferable to you, you may want use the Atx-style headings in order to get more than two levels of hierarchy.

For example:

# 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
小开

Title Metadata

If you are using MultiMarkdown you can add some metadata at the top of the document

format: complete
title: This is a title for the web-page
css: http://example.com/main.css


First line of visible text

The title will get included in a <title> in the <head> section

You can also include it by reference in the body using [%title])

Sub-sub-headings

There shouldn't be any problem in recognising ### at the start of the first line as a level 3 header to generate <h3> tags. I use this in several implementations of Markdown/MultiMarkdown

You can test it using John Gruber's Dingus, Markable, etc.

Heading offset

At least some Markdown/Multimarkdown implementations allow you to specify an offset for generated headings so that it generates <h2> and <h3> instead of <h1> and <h2>.

This would allow you to put, for example, <h1>Title</h1> or <h1>[%title]</h1> as the first line of your document (after metadata declarations).

References

小开

If you are referring to pandoc markdown specifically the simplest approach is to use '%', e.g.

% Document Title


# Header 1


content


## Header 2


## Header 2

see http://pandoc.org/README.html#metadata-blocks for more information on pandoc markdown.

小开

I write books and research papers in Markdown that I post exclusively on GitHub and HTML title tags in Markdown don't work on GitHub so I use the convention that:

Document Title
==============


***This is a subtitle***


**Author:** *Me*


# Chapter One: Overview


Do you know the way?


---


# Chapter Two: Foo


Foo is the way...


---

Which ends up looking like:

Document Title

This is a subtitle

Author: Me

Chapter One : Overview

Do you know the way?

Chapter Two : Foo

Foo is the way...

I use the --- in order to separate chapters because it looks good and helps to find the chapter in the text. This does present a problem however when the Markdown document becomes large in which case the Markdown Preview Window then begins to freeze up on you every time you type as it refreshes or Grammarly starts to bug out and take a REALLY long time. This is the justification for using the === H1 Title Format because when the document gets large you need to break it up, in which case it's nice to use the format:

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)

Which then looks like:

Document Title

This is a subtitle

Author: Me

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

Chapter Two : Foo

Foo is the way...

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

I have also given up on using the Wiki filename for the Title because it does not allow for hyphenated words, which messes up my chapter titles, so I've switched to all lowercase filenames starting with the chapter index 01_chapter_name.md, 02_chapter_name-with-hyphens.md, ... with the === H1 Title Format and moved my Markdown books into the main repository so I can use Issue Driven Development and GitHub Issues and Projects with one Project per chapter so I can remember all of the things to do and get through the backlog.

小开

If you don't mind using RStudio, Rmd (rmarkdown) files generate the title using a metadata section at the top, and then use #+ for headers.

Links

小开

There's a brute-force one-off solution that I thought I'd post:

<font size="+12"><center>
Things to Do
</center></font>

There's definitely a more sophisticated way of doing this, but I found that since this is used once per document, it's not so bad.


提交答案