3 typesetools

Markdown¶

创建之初，Markdown 的基本语法只支持的标题、引用、列表、代码、强调、斜体、链接、内嵌 html 等；且后续发展并没有一个明确和统一的官方标准。而为了满足不同的需求，许多 Markdown 处理器引入了各种扩展语法，导致不同的 Markdown 解释器以不同的方式实现 Markdown 语法 ¹。

例如本网站使用 mkdocs 实现，支持一个称为 admonition 或者叫 callout 的块，即如上面的 wiki 内容，其语法如下，实际样例 ：

??? wiki "Markdown"

    Markdown ...    

而 GitHub 或者是我使用的笔记软件 obsidian 对此对应语法为：

> [!wiki]+ Markdown
>
> Markdown ...

对于 markdown 的基础语法实在太常见了，鹤翔学长的 Markdown 教学也非常详细，我不准备全部讲解，

• 仅仅在 markdown.com.cn 展示基本语法，
• 在 Arya 在线 Markdown 编辑器 展示一些高级的用法；
• 有考虑到 markdown 中可以嵌入简单的 html，所以也以 jyshare 的在线工具 中的模块简单进行讲解。

如果还有不懂的地方，或者你只是单纯想系统地学语法而非听我巴拉巴拉扯一堆东西和演示，markdown.cn 可能是个很好的选择。

抛弃对美化的高要求（事实上通过平台支持，设计好 css 样式、使用 html、引入扩展语法，同样会很好看），markdown 能够很好地实现传递信息的功能，同时 markdown 很容易转变为其它类型的文本标记语言（如 html），所以常用于记录笔记、转变为网页文章（个人网站也好，cc98、知乎、微信公众号等交流平台也好）；具体大家之后选择使用什么类型的工具这里仅以本人知晓的工具作推荐，不全、且 - 标记为未使用过（除 vscode 都支持实时渲染）：

• vscode + Markdown All in One + Markdown Preview Enhanced
  • 作为 宇宙最强 IDE，vscode 基本可以实现任何编辑工作，我们在之后讲解 vscode 时再来演示；
• obsidian or -typora or -Marktext
  • 本地 markdown 笔记软件代表；
  • 【私货】我主要使用 obsidian，简要介绍可见 Obsidian_begin；
  • 【私货】cc98 帖：markdown 笔记软件推荐——obsidian ; obsidian 终极使用经验贴
• 飞书 or 语雀 or -notion
  • 在线 markdown 笔记软件代表。

Word¶

大家总是认为 word 排版 “不符合自己程序员 / 码农 /..” 的身份，觉得其 “谁都能用” “排版丑陋”；但实际上下面要讲的 Latex/Typst 讲完后你同样会觉得谁都能用，且让一个自诩很懂的人来从头开始写也不见得能有多好看；有一个好的模板 word 同样能写出好看的论文。

又或许正是因为 word 本身功能太强大，编写者迷失于调节样式，同时批量调整样式时出现纰漏可能性极高（尽管 word 工具本身支持指定内容的样式调整），这是我们不常使用其在一些学术 / 出版领域的原因之一。

我们无需看懂这些奇怪的标签内容，只需要了解编辑的文本不过是在内部使用这样那样的语法进行了修饰，便于我们稍后总结。

[!extra]- 那如果我用解压缩软件尝试解压缩 demo.doc 文件，会咋样？

可以自己试试将文件扩展名改为 .zip 解压，可以发现结果是几个无扩展名文件，使用文本编辑器打开也是“乱码”形式。

LaTeX¶

• 优点：编写者注重于内容，排版效果好，数学公式排版强大，开源模板众多，被广泛接受……
• 缺点：学习成本高，易排错，设置样式复杂，编译速度慢（线性执行、宏展开、重头编译……）

详细介绍、语法使用在鹤翔学长的 LaTeX 排版简要介绍 中讲解得非常详细了，同时基于我自己也只是在 markdown 中使用其数学公式、或者是为了写论文用用模板，我同样不想进行详细地讲解，仅对 “命令，结构，宏包，环境，公式” 几个关键词在 overleaf or 中文站 进行讲解演示（overleaf 简单介绍），居于此你也足够学会使用一个模板。

Overleaf 基本介绍 ¶

打开 overleaf , 登入后往往进入你的 "project" 仓库，帮我们保留着 projects；右上角是其收集的 Template，当然大家也可以去浏览器中搜寻符合自己需求的模板；由于 LaTeX 的广泛使用，你需要的所有功能应该都能够找到模板。我们新建一个项目，之后从 A quick guide to LaTeX 这个模板开始。

一般我们更加习惯于 Code Editor，左边为源码， ctrl+s / commands+s 或者点击 Recopile 进行编译，右边展示内容。

命令 ¶

LaTeX 的指令，告诉 LaTeX “做什么”，一般包含

• 反斜杠 \ ：放在开头，作为 LaTeX 识别命令的标志对。
• 命令名称：反斜杠后紧跟命令的名称，通常由字母组成，大小写敏感。例如，\documentclass、\begin、\end、\usepackage。
• 参数：有些命令需要参数来指定命令的作用对象或行为
  • 必须参数放在 {} 中，命令必须有这些参数才能正常工作。
  • 可选参数放在 [] 中，命令可以根据需要选择性地使用这些参数。
  • \(\LaTeX\) ？

在 LaTeX 中，宏是一种预定义的命令序列，可以用来简化重复性任务、创建自定义命令或修改现有命令的行为。宏本质上是一种文本替换机制：当你使用一个宏时，LaTeX 会将它替换为预定义的文本或命令序列。相信大家在学习 C 语言的时候也有所理解了。

\newcommand¶

LaTeX 中，主要使用 \newcommand 和 \renewcommand 命令来定义宏。

• \newcommand{\命令名}[参数个数]{定义}：定义一个新的宏。如果命令名已存在，则会报错。
• \renewcommand{\命令名}[参数个数]{定义}：重新定义一个已存在的宏。

文件结构 ¶

对于一篇（短）论文，其内容结构一般如下：

\documentclass{article}  % I am a comment.
% Introduction Area
% use package; set info; new command; set style; ...
% use package
\usepackage{graphicx} % Required for inserting images
\usepackage{lipsum} % generate lore ipsum
\usepackage{subfiles} % import sub files
% set info
\title{demo}
\author{Darstib Reed}
\date{April 2025} % [option], or \date{\today}
% new command
\newcommand{\mybinomial}[3][2]{(#2 + #3)^{#1}}

\begin{document}
% content

\maketitle

\begin{abstract} This is the abstract for this paper. \end{abstract}

\section{Introduction} % generate a 1-level title

Hello world!

\subsection{}

\mybinomial[3]{x}{y}

\end{document} % content after this line will be ignored.

\documentclass¶

简单来说，documentclass 是决定接下来要生成的文档是什么类型的，一般包括：article, report, book, slides, letter ，大多情况下我们使用 article 。

关于可选参数，可以参考：LaTeX documentclass options illustrated

\usepackage¶

就像很多编程语言将常用功能 / 类进行封装，方便调用以提高效率；TeX 中将具有特定功能的宏打包成宏包；经过发布 / 采用，我们可以使用 \usepackage{package} 来使用其中的宏。

一般来说，\documentclass{article} 引入的宏包中没有直接支持中文的宏，往往导致："LaTeX Error: Unicode character"；我们可以通过引入 "ctex" 宏包或者使用 ctexart ctexrep ctexbook 等文档类 \documentclass{ctexart} 。

\begin \end¶

在 LaTeX 中，环境是用于对文档中的特定区域应用特定格式或样式的命令，通常用于创建列表、表格、居中内容、数学公式等，使用 \begin{} 和 \end{} 进行包裹，一般形式如下：

\begin{environment}[optional args]{required args}
... 
\end{environment}

\begin{center}
    center content
\end{center}

\maketitle¶

• \maketitle 命令会调用 LaTeX 内部的 \@maketitle 命令来实际生成标题；
• \@maketitle 命令的定义取决于所使用的文档类（article、report、book 等）；
• 生成标题页 & how does '\maketitle' work? 了解更多。

内容排版 ¶

对于我们排版时常用内容如下（各行具体功能在课上简单提及）：

\begin{document} % content

\maketitle % title

\begin{abstract} This is the abstract for this paper. \end{abstract}

\tableofcontents % toc

\newpage

\section{1-level title} % generate a 1-level title

Hello world! \mybinomial[3]{x}{y}

\subsection{2-level title}

\paragraph{sub part 1:}
\lipsum[30]
\subparagraph{sub part 2:}
\lipsum[30] 

\lipsum[30]

\vspace{1 em}

\lipsum[30]

\indent \lipsum[30] \hspace{2 em} \lipsum[30]

\subsubsection{Text Formatting Commands}
\label{3-level title}

\% is a special char % special char

\textbf{This text will be bold.}

\textit{This text will be italic.}
\emph{This text will be emphasized (usually italic).}

\underline{This text will be underlined.}

\texttt{This text will be in monospace font.}

1, 2, \ldots, n

\begin{itemize} % unordered list
    \item Item 1
    \item Item 2
\end{itemize}

\begin{enumerate} % ordered list
    \item Item 1
    \item Item 2
\end{enumerate}

This is an inline formula: $E=mc^2$. Here are Displayed math formulas:

$$ % without number
    E=mc^2
$$
\begin{equation} % with number
    E=mc^2
\end{equation}

\newpage
% \includegraphics[width=0.5\textwidth]{imgs/map.jpeg}

\begin{figure}[t] % placement: h 当前位置，t 页面顶部，b 页面底部，p 单独一页
    \centering
    \includegraphics[width=0.5\textwidth]{imgs/map.jpeg}
    \caption{Figure caption}
    \label{fig:zjg-map}
\end{figure}

Footnote\footnote{this is a footnote} is enable.

\begin{table}[b]
    \centering
    \begin{tabular}{|c|c|}
        \hline
        Column 1 & Column 2\\
        \hline
        Data 1 & Data 2 \\
        \hline
    \end{tabular}
    \caption{Table caption}
    \label{tab:demo_table}
\end{table}

Figure \ref{fig:zjg-map} is the map of zjg of ZJU.
Title \ref{3-level title} is what 3-level title looks like. 

\cite{einstein1905} is a bib cite article. 

\subfile{sub.tex}

\section*{Conclusion} % * for not numbering

\bibliographystyle{ieeetr} % format
\bibliography{refs.bib} % bib source

\end{document} % content after this line will be ignored.

当然，也许你觉得现在展现出来很难看；更多时候（或者说对绝大多数人的每次使用）都是从一个模板开始，那里的样式往往会整齐美观；我们不关注那些，也不在此讲解；我们只需要看懂需要修改的部分即可。

自己稍加尝试后，相信你应该能够看懂 latex sheet 了；再之后，你应该具备了依据模板（借助搜索引擎和人工智能）完成一篇报告 / 论文的排版工作的能力，试试在撰写课程报告时使用、（各类文件掌握几个模板）练习即可。

Typst¶

• Typst_begin

概览总结 ¶

各个工具的比较如下，大家可以自主选择使用的工具：

参考资料 ¶

• 链接很多，均在文中指出

如果这对你有用的话，请给我点个star吧 ===>