Skip to content

Commit

Permalink
[WNMGDS-158] Update site package documentation (#517)
Browse files Browse the repository at this point in the history
* Update documentation for previewing a site pacakge

* Update header

* fixing typo

* Updating the site pacakge doc info
  • Loading branch information
line47 authored Oct 17, 2019
1 parent 39dc499 commit 3f849b4
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions packages/docs/src/pages/startup/site-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,15 @@ The documentation site should load at the address: http://localhost:3000/
### Previewing your site package
The CMS Design System supports the ability to preview your project's theme in the context of the design system's documentation site. This can be a convenient way to preview how your project's Sass affects the existing component styles.
The CMS Design System supports the ability to preview your project's theme in the context of the design system's documentation site. This can be a convenient way to preview how your project's Sass affects the existing component styles as well as test any custom components.
* Run **`yarn start:theme`** to generate documentation and preview your theme's styles. A `docs` sub-directory will be placed in your theme's directory.
* Run **`yarn build:theme`** to compile the documentation site for your theme. A `docs` sub-directory will be placed in your theme's directory.
* **Note**:
- If you have multiple themes inside of `packages/themes`, you can specify which theme to run by passing the name of the folder. For example, `yarn start:theme my-theme-folder-name`
- If your documentation site will be uploaded to a subdirectory like `example.com/design-system`, you can set the root path by passing the `--root` option. For example, `yarn build:theme --root design-system`
1. Run `yarn start:theme` to generate documentation and preview your theme's styles. A `docs` sub-directory will be placed in your theme's directory.
1. Run `yarn build:theme` to compile the documentation site for your theme. A `docs` sub-directory will be placed in your theme's directory.
**Note**:
* If you have multiple themes inside of `packages/themes`, you can specify which theme to run by passing the name of the folder. For example, `yarn start:theme my-theme-folder-name`
* If your documentation site will be uploaded to a subdirectory like `example.com/design-system`, you can set the root path by passing the `--root` option. For example, `yarn build:theme --root design-system`
* If you are wanting to preview your theme from another GitHub repo copy the site package files into the packages > themes directory.
### How to create documentation for your site package
Expand Down

0 comments on commit 3f849b4

Please sign in to comment.