Skip to content

feat: Add favicon option #1207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 22, 2019
Merged

feat: Add favicon option #1207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion __tests__/__snapshots__/test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'>
Expand Down
1 change: 1 addition & 0 deletions docs/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/commands/shared_options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
7 changes: 4 additions & 3 deletions src/default_theme/index._
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'>
Expand Down