Skip to content
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

add doc for reserved metadata #514

Merged
merged 3 commits into from
Jul 20, 2016
Merged

add doc for reserved metadata #514

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a17c31
add doc for reserved metadata
superyyrrzz Jul 20, 2016
61fef4b
resolve comments
superyyrrzz Jul 20, 2016
d6f5bfb
resolve comments
superyyrrzz Jul 20, 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
17 changes: 17 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 @@ -277,6 +277,23 @@ Please refer to [How to Create Custom Templates](howto_create_custom_template.md
}
```

#### 3.2.2 Reserved Metadata
After passing values through global metadata or file metadata, DocFX can use these metadata in templates to control the output html.
Reserved metadatas:

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.
_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.
_disableToc | bool | Indicate whether to show table of contents on the left of page.
_disableAffix | bool | Indicate whether to show the affix bar on the right of page.
_disableContribution | bool | Indicate whether to show the `View Source` and `Improve this Doc` buttons.
_gitContribute | object | Customize the `Improve this Doc` URL button for public contributors. Use `repo` to specify the contribution repository URL. Use `branch` to specify the contribution branch. Use `path` to specify the folder for new overwrite files .


4. Supported File Mapping Format
---------------------------------------------
There are several ways to define file mapping.
Expand Down