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 support for Web App Manifest in siteConfig #934

Merged
merged 3 commits into from
Sep 2, 2018
Merged

Add support for Web App Manifest in siteConfig #934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96f7ef5
Add support for Web App Manifest in siteConfig
tirthbodawala Aug 31, 2018
0bf1732
Update api-site-config.md
yangshun Sep 2, 2018
fb8287b
Update api-site-config.md
yangshun Sep 2, 2018
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 docs/api-site-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ h1 {
* `defaultLang` defines a default language. It will be used if one is not specified at the top of the code block. You can find the [list of supported languages here](https://github.com/isagalaev/highlight.js/tree/master/src/languages).
* `themeUrl` is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.

`manifest` - Path to your web app manifest (e.g., `/manifest.json`). This will add a `<link>` tag to `<head>` with `rel` as `"manifest"` and `content` as the provided path.

`markdownPlugins` - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

`ogImage` - Local path to an Open Graph image (e.g., `img/myImage.png`). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.
Expand Down
3 changes: 3 additions & 0 deletions lib/core/Head.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ class Head extends React.Component {
{this.props.redirect && (
<meta httpEquiv="refresh" content={`0; URL=${this.props.redirect}`} />
)}
{this.props.config.manifest && (
<link rel="manifest" content={siteUrl + this.props.config.manifest} />
)}
<link
rel="shortcut icon"
href={this.props.config.baseUrl + this.props.config.favicon}
Expand Down