☰

使用 Markdown 或类似工具生成包含页码的目录文档？

tag-icon • tag-icon markdown multimarkdown
使用 Markdown 或类似工具生成包含页码的目录文档？

我需要创建一个大型文档，打印后会有几百页。我想用 Markdown 之类的东西来做这件事。我的要求之一是文档必须有页码和目录。有没有办法使用 Markdown 或类似的标记语言自动生成带有相关页码的目录？到目前为止，我见过的 Markdown 的所有内容都可以自动生成 HTML 输出的目录，但没有相关的页码。

答案1

听起来像是一份工作潘多克。

HTML 没有“页面”的概念；它可能是可能的用<div></div>标签将某些东西拼凑在一起，但我只会使用 PDF：

pandoc --toc --chapters -o output.pdf input1.mkd input2.mkd

Pandoc 可以接受任意数量的输入；它会在每个输入的末尾添加一个换行符并将它们连接起来。上述命令将创建一个设计为书籍的 PDF - 每个章节（由 1 级标题表示）将从奇数页开始。如果您不想要这种行为，请使用以下命令：

pandoc --toc -V documentclass=report -o output.pdf input1.mkd input2.mkd

如果你想节省纸张，并且不介意章节从前一章结束的地方开始（它们甚至可以从页面中间开始），请调用 pandoc 而不使用以下选项--chapters：

pandoc --toc -o output.pdf input1.mkd input2.mkd

你能生成带有目录的 HTML，但具有您列出的所有限制。也可以使用 pandoc 生成 ODT 和 Microsoft DOC 文档，但我认为它们看起来不太好，尤其是与漂亮的 PDF 生成相比。

使用 pandoc 创建 PDF 需要安装 LaTeX 引擎；这在 Linux 上非常简单，因为存储库中至少有一个引擎，但在 Windows 上可能有点难（我不知道，我从未真正尝试过）。因此，可以使用自定义 LaTeX 模板根据自己的喜好自定义内容 - 但我还没有弄清楚，所以我目前坚持使用（相当不错的）默认设置。

答案2

在 Google 上搜索了几分钟后，我注意到你需要自己的 LaTeX 模板，它可以作为选项传递给 pandoc：

pandoc --toc --chapter --template=yourtemplate.tex -o output.pdf input1.mkd

但是您的模板需要在 LaTeX 网站上进行一些修改。建议您可以使用：

作为起点，您可以使用以下模板。我复制了默认模板https://github.com/jgm/pandoc-templates/blob/master/default.latex并添加了一些额外的东西。

我确信您可以删除大部分 if-end 组合。模板需要它来为用户提供更多选项。

\documentclass[chapterprefix=false,titlepage=false]{scrreprt}
\usepackage[T1]{fontenc}

\usepackage{amssymb,amsmath}
\usepackage{fixltx2e} % provides \textsubscript
% use upquote if available, for straight quotes in verbatim environments
\IfFileExists{upquote.sty}{\usepackage{upquote}}{}
\ifnum 0\ifxetex 1\fi\ifluatex 1\fi=0 % if pdftex
  \usepackage[utf8]{inputenc}
$if(euro)$
  \usepackage{eurosym}
$endif$
\else % if luatex or xelatex
  \ifxetex
    \usepackage{mathspec}
    \usepackage{xltxtra,xunicode}
  \else
    \usepackage{fontspec}
  \fi
  \defaultfontfeatures{Mapping=tex-text,Scale=MatchLowercase}
  \newcommand{\euro}{€}
$if(mainfont)$
    \setmainfont{$mainfont$}
$endif$
$if(sansfont)$
    \setsansfont{$sansfont$}
$endif$
$if(monofont)$
    \setmonofont{$monofont$}
$endif$
$if(mathfont)$
    \setmathfont(Digits,Latin,Greek){$mathfont$}
$endif$
\fi
% use microtype if available
\IfFileExists{microtype.sty}{\usepackage{microtype}}{}
$if(geometry)$
\usepackage[$for(geometry)$$geometry$$sep$,$endfor$]{geometry}
$endif$
$if(natbib)$
\usepackage{natbib}
\bibliographystyle{plainnat}
$endif$
$if(biblatex)$
\usepackage{biblatex}
$if(biblio-files)$
\bibliography{$biblio-files$}
$endif$
$endif$
$if(listings)$
\usepackage{listings}
$endif$
$if(lhs)$
\lstnewenvironment{code}{\lstset{language=Haskell,basicstyle=\small\ttfamily}}{}
$endif$
$if(highlighting-macros)$
$highlighting-macros$
$endif$
$if(verbatim-in-note)$
\usepackage{fancyvrb}
$endif$
$if(tables)$
\usepackage{longtable}
$endif$
$if(graphics)$
\usepackage{graphicx}
% Redefine \includegraphics so that, unless explicit options are
% given, the image width will not exceed the width of the page.
% Images get their normal width if they fit onto the page, but
% are scaled down if they would overflow the margins.
\makeatletter
\def\ScaleIfNeeded{%
  \ifdim\Gin@nat@width>\linewidth
    \linewidth
  \else
    \Gin@nat@width
  \fi
}
\makeatother
\let\Oldincludegraphics\includegraphics
{%
 \catcode`\@=11\relax%
 \gdef\includegraphics{\@ifnextchar[{\Oldincludegraphics}{\Oldincludegraphics[width=\ScaleIfNeeded]}}%
}%
$endif$
\ifxetex
  \usepackage[setpagesize=false, % page size defined by xetex
              unicode=false, % unicode breaks when used with xetex
              xetex]{hyperref}
\else
  \usepackage[unicode=true]{hyperref}
\fi
\hypersetup{breaklinks=true,
            bookmarks=true,
            pdfauthor={$author-meta$},
            pdftitle={$title-meta$},
            colorlinks=true,
            urlcolor=$if(urlcolor)$$urlcolor$$else$blue$endif$,
            linkcolor=$if(linkcolor)$$linkcolor$$else$magenta$endif$,
            pdfborder={0 0 0}}
\urlstyle{same}  % don't use monospace font for urls
$if(links-as-notes)$
% Make links footnotes instead of hotlinks:
\renewcommand{\href}[2]{#2\footnote{\url{#1}}}
$endif$
$if(strikeout)$
\usepackage[normalem]{ulem}
% avoid problems with \sout in headers with hyperref:
\pdfstringdefDisableCommands{\renewcommand{\sout}{}}
$endif$
\setlength{\parindent}{0pt}
\setlength{\parskip}{6pt plus 2pt minus 1pt}
\setlength{\emergencystretch}{3em}  % prevent overfull lines
$if(numbersections)$
\setcounter{secnumdepth}{5}
$else$
\setcounter{secnumdepth}{0}
$endif$
$if(verbatim-in-note)$
\VerbatimFootnotes % allows verbatim text in footnotes
$endif$
$if(lang)$
\ifxetex
  \usepackage{polyglossia}
  \setmainlanguage{$mainlang$}
\else
  \usepackage[$lang$]{babel}
\fi
$endif$
$for(header-includes)$
$header-includes$
$endfor$

$if(title)$
\title{$title$}
$endif$
\author{$for(author)$$author$$sep$ \and $endfor$}
\date{$date$}

\begin{document}
$if(title)$
\maketitle
$endif$

$for(include-before)$
$include-before$

$endfor$
$if(toc)$
{
\hypersetup{linkcolor=black}
\setcounter{tocdepth}{$toc-depth$}
\begingroup
\let\clearpage\relax
\tableofcontents
\endgroup
}
$endif$
$body$

$if(natbib)$
$if(biblio-files)$
$if(biblio-title)$
$if(book-class)$
\renewcommand\bibname{$biblio-title$}
$else$
\renewcommand\refname{$biblio-title$}
$endif$
$endif$
\bibliography{$biblio-files$}

$endif$
$endif$
$if(biblatex)$
\printbibliography$if(biblio-title)$[title=$biblio-title$]$endif$

$endif$
$for(include-after)$
$include-after$

$endfor$
\end{document}

答案3

您考虑过使用 LaTeX 吗？

其他答案建议使用 Pandoc，它看起来可以将 Markdown 转换为 LaTeX，但直接在 LaTeX 中开始可能会更容易。

LaTeX 专为创建打印文档而设计，并内置了页码和目录生成等功能。查看此基本教程： http://www.andy-roberts.net/writing/latex

相关内容