Skip to content

support customizing logo and favicon #892

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
superyyrrzz merged 2 commits into from
Nov 18, 2016
Merged

support customizing logo and favicon #892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2f9602
support customizing logo and favicon
superyyrrzz Nov 14, 2016
018b436
extract logo partial
superyyrrzz Nov 15, 2016
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: 2 additions & 0 deletions Documentation/tutorial/docfx.exe_user_manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,8 @@ Metadata Name | Type | Description
----------------------|---------|---------------------------
_appTitle | string | Will be appended to each output page's head title.
_appFooter | string | The footer text. Will show DocFX's Copyright text if not specified.
_appLogoPath | string | Logo file's path from output root. Will show DocFX's logo if not specified. Remember to add file to resource.
_appFaviconPath | string | Favicon file's path from output root. Will show DocFX's favicon if not specified. Remember to add file to resource.
_enableSearch | bool | Indicate whether to show the search box on the top of page.
_disableNavbar | bool | Indicate whether to show the navigation bar on the top of page.
_disableBreadcrumb | bool | Indicate whether to show breadcrumb on the top of page.
Expand Down
2 changes: 1 addition & 1 deletion src/docfx.website.themes/default/partials/head.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
<meta name="generator" content="docfx {{_docfxVersion}}">
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
<link rel="shortcut icon" href="{{_rel}}favicon.ico">
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.css">
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
<link rel="stylesheet" href="{{_rel}}styles/main.css">
Expand Down
5 changes: 5 additions & 0 deletions src/docfx.website.themes/default/partials/logo.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}

<a class="navbar-brand" href="{{_rel}}index.html">
<img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" >
</a>
4 changes: 1 addition & 3 deletions src/docfx.website.themes/default/partials/navbar.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="{{_rel}}index.html">
<img id="logo" class="svg" src="{{_rel}}logo.svg" alt="{{_appName}}" >
</a>
{{>partials/logo}}
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
Expand Down