From b1ecd989d45d99f110392e2753063cc72d0c4bfb Mon Sep 17 00:00:00 2001 From: Joel Marcey Date: Tue, 30 Jan 2018 12:46:09 -0800 Subject: [PATCH] Add some more information around wrapPagesHTML --- docs/api-site-config.md | 2 +- docs/guides-custom-pages.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api-site-config.md b/docs/api-site-config.md index 807f7070a3ed..cacb55975d09 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -132,7 +132,7 @@ h1 { `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. -`wrapPagesHTML` - boolean flag to indicate whether `html` files in `/pages` should be wrapped with Docusaurus styles with the site header and footer. This feature is experimental and relies on the files being `html` fragments instead of complete pages. It inserts the contents of your `html` file with no extra processing. Defaults to `false`. +`wrapPagesHTML` - boolean flag to indicate whether `html` files in `/pages` should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being `html` fragments instead of complete pages. It inserts the contents of your `html` file with no extra processing. Defaults to `false`. `scripts` - Array of JavaScript sources to load. The script tag will be inserted in the HTML head. diff --git a/docs/guides-custom-pages.md b/docs/guides-custom-pages.md index 976ad873c1bb..8ece6d2f120a 100644 --- a/docs/guides-custom-pages.md +++ b/docs/guides-custom-pages.md @@ -43,6 +43,8 @@ Static `.html` files can also be used, but they will not include Docusaurus's he If you wish to use Docusaurus's stylesheet, you can access it at `${baseUrl}css/main.css`. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus's styles by adding them into the `siteConfig.separateCss` field in `siteConfig.js`. +> You can set the [`$wrapPagesHTML` site config option](site-config.md#optional-fields) in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer. + ## Customizing Your Site Footer Starting from the example `core/Footer.js` file that was [created](getting-started-site-creation.md) when you ran the [Docusaurus initialization script](getting-started-installation.md), edit the footer to include any links to pages on your site or other sites that you wish to have.