Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Task/update configuration documention #2149

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ See examples in the [cookbook](Cookbook.md#how-to-change-styles-of-a-style-guide

## `title`

Type: `String`, default: `<app name from package.json> Style Guide`
Type: `String`, default: `<name field from package.json, replacing hyphens with spaces> Style Guide`

Style guide title.

Expand Down
18 changes: 9 additions & 9 deletions docs/Documenting.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export default class Button extends React.Component {

## Public methods

By default, any methods your components have are considered to be private and are not published. Mark your public methods with JSDoc [`@public`](http://usejsdoc.org/tags-public.html) tag to get them published in the docs:
By default, any methods your components have are considered to be private and are not published. Mark your public methods with JSDoc [`@public`](https://jsdoc.app/tags-public.html) tag to get them published in the docs:

```javascript
/**
Expand All @@ -125,7 +125,7 @@ insertAtCursor(text) {

## Ignoring props

By default, all props your components have are considered to be public and are published. In some rare cases, you might want to remove a prop from the documentation while keeping it in the code. To do so, mark the prop with JSDoc [`@ignore`](http://usejsdoc.org/tags-ignore.html) tag to remove it from the docs:
By default, all props your components have are considered to be public and are published. In some rare cases, you might want to remove a prop from the documentation while keeping it in the code. To do so, mark the prop with JSDoc [`@ignore`](https://jsdoc.app/tags-ignore.html) tag to remove it from the docs:

```javascript
MyComponent.propTypes = {
Expand Down Expand Up @@ -155,17 +155,17 @@ The component will be displayed with a custom “The Best Button Ever 🐙” na

## Using JSDoc tags

You can use the following [JSDoc](http://usejsdoc.org/) tags when documenting components, props and methods:
You can use the following [JSDoc](https://jsdoc.app/) tags when documenting components, props and methods:

- [@deprecated](http://usejsdoc.org/tags-deprecated.html)
- [@see, @link](http://usejsdoc.org/tags-see.html)
- [@author](http://usejsdoc.org/tags-author.html)
- [@since](http://usejsdoc.org/tags-since.html)
- [@version](http://usejsdoc.org/tags-version.html)
- [@deprecated](https://jsdoc.app/tags-deprecated.html)
- [@see](https://jsdoc.app/tags-see.html), [@link](https://jsdoc.app/tags-link.html),
- [@author](https://jsdoc.app/tags-author.html)
- [@since](https://jsdoc.app/tags-since.html)
- [@version](https://jsdoc.app/tags-version.html)

When documenting props you can also use:

- [@param, @arg, @argument](http://usejsdoc.org/tags-param.html)
- [@param, @arg, @argument](https://jsdoc.app/tags-param.html)

All tags can render Markdown.

Expand Down