feat: Add favicon option (#1207)

documentationjs · Feb 22, 2019 · 5b045f2 · 5b045f2
1 parent fb0a27f
commit 5b045f2
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/__tests__/__snapshots__/test.js.snap b/__tests__/__snapshots__/test.js.snap
@@ -1388,12 +1388,12 @@ exports[`html nested.input.js 1`] = `
 <head>
   <meta charset='utf-8' />
   <title> | Documentation</title>
+  <meta name='description' content='a documentation generator'>
   <meta name='viewport' content='width=device-width,initial-scale=1'>
   <link href='assets/bass.css' rel='stylesheet' />
   <link href='assets/style.css' rel='stylesheet' />
   <link href='assets/github.css' rel='stylesheet' />
   <link href='assets/split.css' rel='stylesheet' />
-  <meta name='description' content='a documentation generator'>
 </head>
 <body class='documentation m0'>
     <div class='flex'>

diff --git a/docs/USAGE.md b/docs/USAGE.md
@@ -24,6 +24,7 @@ Options:
                              package.json
   --project-homepage         project homepage. by default, inferred from
                              package.json
+  --favicon                  favicon used in html
   --watch, -w                watch input files and rebuild documentation when
                              they change                               [boolean]
   --markdown-toc             include a table of contents in markdown output

diff --git a/src/commands/shared_options.js b/src/commands/shared_options.js
@@ -106,6 +106,9 @@ module.exports.sharedOutputOptions = {
   'project-homepage': {
     describe: 'project homepage. by default, inferred from package.json'
   },
+  favicon: {
+    describe: 'favicon used in html'
+  },
   format: {
     alias: 'f',
     default: 'json',

diff --git a/src/default_theme/index._ b/src/default_theme/index._
@@ -2,13 +2,14 @@
 <html>
 <head>
   <meta charset='utf-8' />
-  <title><%- config['project-name'] %> <%- config['project-version'] %> | Documentation</title>
+  <title><%- config['project-name'] %> <%- config['project-version'] %> | Documentation</title><% if (config['project-description']) { %>
+  <meta name='description' content='<%- config['project-description'] %>'><% } %>
   <meta name='viewport' content='width=device-width,initial-scale=1'>
   <link href='assets/bass.css' rel='stylesheet' />
   <link href='assets/style.css' rel='stylesheet' />
   <link href='assets/github.css' rel='stylesheet' />
-  <link href='assets/split.css' rel='stylesheet' /><% if (config['project-description']) { %>
-  <meta name='description' content='<%- config['project-description'] %>'><% } %>
+  <link href='assets/split.css' rel='stylesheet' /><% if (config['favicon']) { %>
+  <link href='<%- config['favicon'] %>' rel='icon' ><% } %>
 </head>
 <body class='documentation m0'>
     <div class='flex'>