Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
57cddb4
commit 40a9047
Showing
9 changed files
with
780 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| --- | ||
| id: version-1.0.12-api-pages | ||
| title: Pages and Styles | ||
| original_id: api-pages | ||
| --- | ||
|
|
||
| Docusaurus provides support for writing pages as React components inside the `website/pages` folder which will share the same header, footer, and styles as the rest of the site. | ||
|
|
||
| ## Urls for Pages | ||
|
|
||
| Any `.js` files in `website/pages` will be rendered to static html using the path of the file after "pages". Files in `website/pages/en` will also get copied out into `pages` and will OVERRIDE any files of the same name in `pages`. For example, the page for the `website/pages/en/help.js` file will be found at the url `${baseUrl}en/help.js` as well as the url `${baseUrl}help.js`, where `${baseUrl}` is the `baseUrl` field set in your [siteConfig.js file](api-site-config.md). | ||
|
|
||
| ## Page Require Paths | ||
|
|
||
| Docusaurus provides a few useful React components for users to write their own pages, found in the `CompLibrary` module. This module is provided as part of Docusaurus in `node_modules/docusaurus`, so to access it, pages in the `pages` folder are temporarily copied into `node_modules/docusaurus` when rendering to static html. As seen in the example files, this means that a user page at `pages/en/index.js` uses a require path to `"../../core/CompLibrary.js"` to import the provided components. | ||
|
|
||
| What this means to the user is that if you wish to use the `CompLibrary` module, make sure the require path is set correctly. For example, a page at `page/mypage.js` would use a path `"../core/CompLibrary.js"`. | ||
|
|
||
| If you wish to use your own components inside the website folder, use `process.cwd()` which will refer to the `website` folder to construct require paths. For example, if you add a component to `website/core/mycomponent.js`, you can use the require path, `"process.cwd() + /core/mycomponent.js"`. | ||
|
|
||
| ## Provided Components | ||
|
|
||
| Docusaurus provides the following components in `CompLibrary`: | ||
|
|
||
| ### `CompLibrary.MarkdownBlock` | ||
|
|
||
| A React component that parses markdown and renders to HTML. | ||
|
|
||
| Example: | ||
|
|
||
| ```jsx | ||
| const MarkdownBlock = CompLibrary.MarkdownBlock; | ||
|
|
||
| <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 props that you can configure. | ||
| **Props** | ||
| | Prop | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | `padding` | Array of `'all'`, `'bottom'`, `'left'`, `'right'`, `'top'` | `[]` | Positions of the padding. | | ||
| | `background` | One of `'dark'`, `'highlight'`, `'light'` | `null` | Background styling of the element. | | ||
| | `className` | String | - | Custom class to add to the element. | | ||
| **Example** | ||
| ```jsx | ||
| <Container | ||
| padding={['bottom', 'top']} | ||
| background="light" | ||
| className="myCustomClass"> | ||
| ... | ||
| </Container> | ||
| ``` | ||
| ### `CompLibrary.GridBlock` | ||
| A React component to organize text and images. | ||
| **Props** | ||
| | Prop | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | `align` | One of `'left'`, `'center'`, `'right'` | `'left'` | Text alignment of content. | | ||
| | `layout` | One of `'twoColumn'`, `'threeColumn'`, `'fourColumn'` | `'twoColumn'` | Number of column sections in the `GridBlock`. | | ||
| | `className` | String | - | Custom class to add to the element. | | ||
| | `contents` | Array of content objects | `[]` | Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object. | | ||
| **Content Object** | ||
| | Key | Type | Default | Description | | ||
| | --- | --- | --- | --- | | ||
| | `title` | String | - | The display title of this section, which is parsed using Markdown | | ||
| | `content` | String | - | The text of this section, which is parsed using Markdown | | ||
| | `image` | String | - | The path of the display image | | ||
| | `imageAlt` | String | - | The text that will be shown in case the image is not available | | ||
| | `imageAlign` | One of `'top'`, `'left'`, `'bottom'`, `'right'` | `'left'` | Image alignment relative to the text | | ||
| | `imageLink` | String | - | Link destination from clicking the image | | ||
| **Example** | ||
| ``` | ||
| <GridBlock | ||
| align="center" | ||
| layout="threeColumn" | ||
| className="myCustomClass" | ||
| contents={[ | ||
| { | ||
| title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`, | ||
| content: 'Learn how to use this project', | ||
| image: siteConfig.baseUrl + 'img/learn.png', | ||
| imageAlt: 'Learn how to use this project', | ||
| imageLink: siteConfig.baseUrl + 'docs/tutorial.html', | ||
| }, | ||
| { | ||
| title: 'Frequently Asked Questions', | ||
| content: 'Questions gathered from the community', | ||
| image: siteConfig.baseUrl + 'img/faq.png', | ||
| imageAlign: 'top', | ||
| }, | ||
| { | ||
| title: 'More', | ||
| content: 'Lots of documentation is on this site', | ||
| }, | ||
| ]} | ||
| /> | ||
| ``` | ||
| More examples of how these components are used can be found in the [generated example files](getting-started-preparation.md) as well as in Docusaurus' own repo for its website set-up. | ||
| ## Translating Strings | ||
| When translations are enabled, any pages inside `website/pages/en` will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the `languages.js` file. E.g. The url for a French page of `website/pages/en/help.js` would be found at `${baseUrl}fr/help.html`. | ||
| When writing pages that you wish to translate, wrap any strings to be translated inside a `<translate>` tag. e.g., | ||
| ```jsx | ||
| <p> | ||
| <translate>I like translations</translate> | ||
| </p> | ||
| ``` | ||
| You can also provide an optional description attribute to provide context for translators. e.g, | ||
| ```jsx | ||
| <a href="/community"> | ||
| <translate desc="Footer link to page referring to community GitHub and Slack"> | ||
| Community | ||
| </translate> | ||
| </a> | ||
| ``` | ||
| Add the following require statement as well: | ||
| ```js | ||
| const translate = require('../../server/translate.js').translate; | ||
| ``` | ||
| Note that this path is valid for files inside `pages/en` and should be adjusted accordingly if files are in different locations, as discussed [above](#page-require-paths). | ||
| ## Using Static Assets | ||
| Static assets should be placed into the `website/static` folder. They can be accessed by their paths, excluding "static". For example, if the site's `baseUrl` is "/docusaurus/", an image in `website/static/img/logo.png` is available at `/docusaurus/img/logo.png`. | ||
| ## Styles | ||
| You should configure your site's primary, secondary, and code block colors using the `colors` field in `siteConfig` as specified [here](api-site-config.md). You can also configure other colors in the same way as described in the `siteConfig` doc. | ||
| You can provide your own custom styles by adding them anywhere in the `website/static` folder. Any `.css` files you provide in the `static` folder will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish. | ||
| An easy way to figure out what classes you wish to override or add to is to [start your server locally](api-commands.md) and use your browser's inspect element tool. |
Oops, something went wrong.