Skip to content

Latest commit

 

History

History
138 lines (99 loc) · 2.13 KB

markdown2word.README.md

File metadata and controls

138 lines (99 loc) · 2.13 KB
Raw

markdown2word-doc-template

Markdown to Word Document Template

Init New File Project

mkdir PROJECT_NAME && cd "$_"
curl -L https://github.com/hailiang-wang/markdown2word-doc-template/tarball/master | tar xz --strip-components=1

Replace PROJECT_NAME with new names, e.g.

mkdir Report2022 && cd "$_"
curl -L https://github.com/hailiang-wang/markdown2word-doc-template/tarball/master | tar xz --strip-components=1

Create New Readme

./scripts/manual.sh

Build new XMind File

# Windows
start README.xmind

# macOS
open README.xmind

Autocorrect Grammer

Auto fix CJK Grammer with English.

./scripts/autocorrect.sh

Deps

  • Python 3
  • Pandoc 2.11+
  • Git && Git Bash for Windows
pip install -r requirements.txt

Add Markdown Files

Start from sources/index.m.md, add xxx.m.md markdown files described in mark-markdown-up.

Add Media Assets

Add files, artifacts in assets.

Build Office Word File

./scripts/docx.sh

Build HTML File

./scripts/html.sh

Collect Ouput Files

Copy works as final result into dist.

Add a Cover

Get cover samples in assets/covers.

Save cover in Office Word.

Sample Markdown File

default.m.md

Tune Styles in Two Ways

  1. Modify styles/default.m.md

Then, run scripts/style.sh

  1. Modify styles/default.docx directly
Paragraph styles:

Normal
Body Text
First Paragraph
Compact
Title
Subtitle
Author
Date
Abstract
Bibliography
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Heading 7
Heading 8
Heading 9
Block Text
Footnote Text
Definition Term
Definition
Caption
Table Caption
Image Caption
Figure
Captioned Figure
TOC Heading
Character styles:

Default Paragraph Font
Body Text Char
Verbatim Char
Footnote Reference
Hyperlink
Section Number
Table style:

Table