diff --git a/docs/api-site-config.md b/docs/api-site-config.md index a51ddb2c0850..a322d39e6ac1 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -5,12 +5,24 @@ title: siteConfig.js A large part of site configuration is done by editing the `siteConfig.js` file. +
+ + + +
+ +
+ ## User Showcase The `users` array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the `pages/en/index.js` and `pages/en/users.js` files provided. Each user object should have `caption`, `image`, `infoLink`, and `pinned` fields. The `caption` is the text showed when someone hovers over the `image` of that user, and the `infoLink` is where clicking the image will bring someone. The `pinned` field determines whether or not it shows up on the `index` page. Currently this `users` array is used only by the `index.js` and `users.js` example files. If you do not wish to have a users page or show users on the `index` page, you may remove this section. +
+ +
+ ## siteConfig Fields The `siteConfig` object contains the bulk of the configuration settings for your website. @@ -187,6 +199,10 @@ h1 { Users can also add their own custom fields if they wish to provide some data across different files. +
+ +
+ ## Example siteConfig.js with many available fields ```js @@ -283,3 +299,5 @@ const siteConfig = { module.exports = siteConfig; ``` + +
diff --git a/v1/lib/core/DocsLayout.js b/v1/lib/core/DocsLayout.js index 9fc259935a77..9ded0fb44d1a 100644 --- a/v1/lib/core/DocsLayout.js +++ b/v1/lib/core/DocsLayout.js @@ -76,6 +76,39 @@ class DocsLayout extends React.Component { language={metadata.language} version={metadata.version} metadata={metadata}> + { +