3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-11 08:07:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add the ability to provide custom layout (#128)

Browse source 
* Add the ability to provide custom layout

When I designed the system, I added the ability to provide a custom layout that would use arbitrary JavaScript to render some custom pages. This is why files are called "DocsLayout.js", "BlogPostLayout.js"... This ability to customize it was [ripped out](https://github.com/facebook/react-native/blob/master/website/server/convert.js#L78) during the migration to Docusaurus but I need it for the project I'm working on right now (that should remain unnamed!).

This adds back the ability to do it in a way that fits the third party system. In order to provide a new layout:

1) Add a `layout` field in the header of your markdown file:

```js
---
layout: mylayout
---
```

2) In your `siteConfig`, add

```js
  layouts: {
    mylayout: function({React, Marked}) {
      return class extends React.Component {
        render() {
           return React.createElement('div', {}, this.props.metadata.layout);
         }
      }
    }
  }
```

I think that it's a reasonable to add and would unblock me :)

* Update DocsLayout.js
This commit is contained in:
Christopher Chedeau 2017-10-18 10:20:13 -07:00 • committed by Joel Marcey
parent 5693eba5d1
commit a26bba14c6
2 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lib/core/DocsLayout.js
View file

@ -18,6 +18,10 @@ class DocsLayout extends React.Component {
const metadata = this.props.metadata;
const content = this.props.children;
const i18n = translation[this.props.metadata.language];
let DocComponent = Doc;
if (this.props.Doc) {
DocComponent = this.props.Doc;
}
return (
<Site
config={this.props.config}
@ -36,7 +40,8 @@ class DocsLayout extends React.Component {
<div className="docMainWrapper wrapper">
<DocsSidebar metadata={metadata} />
<Container className="mainContainer">
<Doc
<DocComponent
metadata={metadata}
content={content}
config={this.props.config}
source={metadata.source}