From 4e6118207e2c8cdff34a157b1350f8c0f251b1ea Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Mon, 9 Apr 2018 02:38:54 +0000 Subject: [PATCH] Deploy website Deploy website version based on b348c38f1c3bc7a4a287f993f072b42741f15def --- docs/en/api-pages.html | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/en/api-pages.html b/docs/en/api-pages.html index 36c3e31d53..c14910c180 100644 --- a/docs/en/api-pages.html +++ b/docs/en/api-pages.html @@ -21,23 +21,28 @@ <MarkdownBlock>[Markdown syntax for a link](http://www.example.com)</MarkdownBlock>

CompLibrary.Container

-

A React container component using Docusaurus styles. Has optional padding and background color attributes that you can configure.

-

Padding choices: all, bottom, left, right, top.
-Background choices: dark, highlight, light.

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Padding choices: 'all', 'bottom', 'left', 'right', 'top'.
+Background choices: 'dark', 'highlight', 'light'.

+

The className prop is an optional prop that allows you to your own class names to the Container instance. It works like the className attribute in JSX. You can use this class name to customize the styling of contents within this Container.

Example:

-
<Container padding={["bottom", "top"]} background="light">
+
<Container
+  padding={["bottom", "top"]}
+  background="light"
+  className="myCustomClass">
   ...         
 </Container>
 

 
CompLibrary.GridBlock

 
A React component to organize text and images.

-
The align attribute determines text alignment. Text alignment defaults to left and can be set to center or right.

-
The layout attribute determines number of column sections per GridBlock. layout defaults to twoColumn and can be set to threeColumn or fourColumn as well.

-
The contents attribute is an array containing the contents of each section of the GridBlock. Each content object can have the following fields:

+
The align prop determines text alignment. Text alignment defaults to 'left' and can be set to 'center' or 'right'.

+
The layout prop determines number of column sections per GridBlock. layout defaults to 'twoColumn' and can be set to 'threeColumn' or 'fourColumn' as well.

+
The className prop is an optional prop that allows you to your own class names to the GridBlock instance. It works like the className attribute in JSX. You can use this class name to customize the styling of contents within this GridBlock.

+
The contents prop is an array containing the contents of each section of the GridBlock. Each content object can have the following fields:

 
    
 
  • content for the text of this section, which is parsed from markdown
    • 
 
  • image for the path to an image to display
    • 
-
  • imageAlign field for image alignment relative to the text, which defaults to top and can be set to bottom, left, or right
    • 
+
  • imageAlign field for image alignment relative to the text, which defaults to 'top' and can be set to 'bottom', 'left', or 'right'
    • 
 
  • title for the title to display for this section, which is parsed from markdown
    • 
 
  • imageLink for a link destination from clicking the image
    • 
 
  • imageAlt for the description of what text will be shown in case the image is not available
    • 
@@ -45,6 +50,8 @@ Background choices: dark, highlight, lightExample:
    
 
    <GridBlock
   align="center"
+  layout="threeColumn"
+  className="myCustomClass"  
   contents={[
     {
       content: "Learn how to use this project",
@@ -64,7 +71,6 @@ Background choices: dark, highlight, light"More"
     }
   ]}
-  layout="threeColumn"
 />
 
    
 
    More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repo for its website set-up.