Template for writing a PhD thesis in Markdown
A Markdown template and toolchain for writing and compiling a PhD thesis with pandoc, supporting PDF, HTML, and LaTeX outputs.
What is Template for writing a PhD thesis in Markdown?
phd_thesis_markdown is a template and toolchain for writing a PhD thesis entirely in Markdown, which is then converted to PDF, HTML, or LaTeX using pandoc. It solves the problem of complex thesis formatting by automating reference management, cross-referencing, and document compilation, allowing researchers to write in a simple plain-text format while producing professionally typeset documents.
PhD students and academic researchers who want to write their thesis or long-form documents in Markdown, especially those familiar with version control and command-line tools who prefer a plain-text workflow over traditional word processors.
It offers a lightweight, version-control-friendly alternative to heavy word processors like Word or complex LaTeX setups, combining Markdown's simplicity with LaTeX's output quality through automated pandoc pipelines.
Overview
Template for writing a PhD thesis in Markdown
Use Cases
Best For
- Writing a PhD thesis in Markdown instead of Word or pure LaTeX
- Automating figure, table, and equation numbering in academic documents
- Generating PDF and HTML versions of the same thesis from a single source
- Managing thesis references with BibTeX and customizable citation styles
- Collaborating on thesis drafts using Git version control
- Customizing thesis formatting for different university requirements
Not Ideal For
- Institutions or collaborators requiring real-time editing and submission in Microsoft Word formats
- Users who prefer WYSIWYG editors without command-line or version control involvement
- Projects demanding highly complex, non-standard LaTeX layouts that exceed the template's customization
Pros & Cons
Pros
Combines Markdown's readability for writing with embedded LaTeX for equations, allowing focus on content while maintaining typesetting quality, as described in the philosophy.
Uses a Makefile and pandoc to generate PDF, HTML, and LaTeX outputs automatically, with pandoc-crossref handling figure, table, and equation numbering, reducing manual formatting.
Plain text files are inherently compatible with Git, enabling easy change tracking and collaboration, highlighted as a key advantage in the README.
Includes LaTeX templates and style files that can be adapted for different university requirements, providing flexibility without starting from scratch.
Cons
The README explicitly states that Word output 'needs work,' making it unreliable for workflows or submissions requiring .docx formats.
Requires installing pandoc 3.1+, pandoc-crossref, and TeX packages with platform-specific steps, which can lead to errors like 'make: *** [pdf] Error 43' as noted in troubleshooting.
Niche or complex formatting may require writing raw LaTeX or diving into Haskell/Lua filters, which might not render in non-PDF outputs, adding complexity.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.