feat: add the option to set the document title (#100)

simonhaenisch · Sep 23, 2021 · 519fbc9 · 519fbc9
1 parent 066e066
commit 519fbc9
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 1 deletion.
diff --git a/readme.md b/readme.md
@@ -59,6 +59,7 @@ Options:
   --basedir ................ Base directory to be served by the file server
   --stylesheet ............. Path to a local or remote stylesheet (can be passed multiple times)
   --css .................... String of styles
+  --document-title ......... Name of the HTML Document.
   --body-class ............. Classes to be added to the body tag (can be passed multiple times)
   --page-media-type ........ Media type to emulate the page with (default: screen)
   --highlight-style ........ Style to be used by highlight.js (default: github)
@@ -149,6 +150,7 @@ pdf_options:
       }
     </style>
     <section>
+      <span class="title"></span>
       <span class="date"></span>
     </section>
   footerTemplate: |-
@@ -183,6 +185,7 @@ For default and advanced options see the following links. The default highlight.
 | `--basedir`             | `path/to/folder`                                                      |
 | `--stylesheet`          | `path/to/style.css`, `https://example.org/stylesheet.css`             |
 | `--css`                 | `body { color: tomato; }`                                             |
+| `--document-title`      | `Read me`                                                             |
 | `--body-class`          | `markdown-body`                                                       |
 | `--page-media-type`     | `print`                                                               |
 | `--highlight-style`     | `monokai`, `solarized-light`                                          |

diff --git a/src/cli.ts b/src/cli.ts
@@ -29,6 +29,7 @@ export const cliFlags = arg({
 	'--watch-options': String,
 	'--stylesheet': [String],
 	'--css': String,
+	'--document-title': String,
 	'--body-class': [String],
 	'--page-media-type': String,
 	'--highlight-style': String,

diff --git a/src/lib/config.ts b/src/lib/config.ts
@@ -8,6 +8,7 @@ export const defaultConfig: Config = {
 	stylesheet: [resolve(__dirname, '..', '..', 'markdown.css')],
 	script: [],
 	css: '',
+	document_title: '',
 	body_class: [],
 	page_media_type: 'screen',
 	highlight_style: 'github',
@@ -78,6 +79,11 @@ interface BasicConfig {
 	 */
 	script: FrameAddScriptTagOptions[];
 
+	/**
+	 * Name of the HTML Document.
+	 */
+	document_title: string;
+
 	/**
 	 * List of classes for the body tag.
 	 */

diff --git a/src/lib/get-html.ts b/src/lib/get-html.ts
@@ -6,7 +6,7 @@ import { getMarked } from './get-marked-with-highlighter';
  */
 export const getHtml = (md: string, config: Config) => `<!DOCTYPE html>
 <html>
-<head><meta charset="utf-8"></head>
+<head><title>${config.document_title}</title><meta charset="utf-8"></head>
 <body class="${config.body_class.join(' ')}">
 ${getMarked(config.marked_options)(md)}
 </body>

diff --git a/src/lib/help.ts b/src/lib/help.ts
@@ -12,6 +12,7 @@ const helpText = `
     --basedir ${chalk.dim('................')} Base directory to be served by the file server
     --stylesheet ${chalk.dim('.............')} Path to a local or remote stylesheet (can be passed multiple times)
     --css ${chalk.dim('....................')} String of styles
+    --document-title ${chalk.dim('.........')} Name of the HTML Document.
     --body-class ${chalk.dim('.............')} Classes to be added to the body tag (can be passed multiple times)
     --page-media-type ${chalk.dim('........')} Media type to emulate the page with (default: screen)
     --highlight-style ${chalk.dim('........')} Style to be used by highlight.js (default: github)