Skip to content

Commit

Permalink
fix: Update site links
Browse files Browse the repository at this point in the history
  • Loading branch information
sapegin committed Jul 3, 2020
1 parent 5492d3f commit e662394
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/Contributing.md
Expand Up @@ -10,7 +10,7 @@ If you want to contribute but don’t know what to do, take a look at these two
- Install [EditorConfig](http://editorconfig.org/) plugin for your code editor to make sure it uses correct settings.
- Fork the repository and clone your fork.
- Install dependencies: `npm install`.
- Read the [developer guide](https://react-styleguidist.js.org/docs/development.html).
- Read the [developer guide](https://react-styleguidist.js.org/docs/development).

## Development workflow

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/Question.md
Expand Up @@ -11,5 +11,5 @@ Before submitting a new question, make sure you:

- Searched existing [Stack Overflow questions](https://stackoverflow.com/questions/tagged/react-styleguidist).
- Searched opened and closed [GitHub issues](https://github.com/styleguidist/react-styleguidist/issues?utf8=%E2%9C%93&q=is%3Aissue).
- Read [the documentation](https://react-styleguidist.js.org/docs/getting-started.html).
- Read [the documentation](https://react-styleguidist.js.org/docs/getting-started).
- Googled your question.
2 changes: 1 addition & 1 deletion .github/Issue_Template.md
Expand Up @@ -6,7 +6,7 @@ Search open/closed issues before submitting since someone might have asked the s
https://github.com/styleguidist/react-styleguidist/issues?utf8=%E2%9C%93&q=is%3Aissue
Read essential documentation (all six pages):
https://react-styleguidist.js.org/docs/getting-started.html
https://react-styleguidist.js.org/docs/getting-started
Make sure you’re using the latest versions of React Styleguidist.
Expand Down
20 changes: 10 additions & 10 deletions Readme.md
Expand Up @@ -14,17 +14,17 @@ React Styleguidist is a component development environment with hot reloaded dev

## Usage

- **[Getting Started](https://react-styleguidist.js.org/docs/getting-started.html): install and run Styleguidist**
- [Documenting components](https://react-styleguidist.js.org/docs/documenting.html): how to write documentation
- [Locating components](https://react-styleguidist.js.org/docs/components.html): point Styleguidist to your React components
- [Configuring webpack](https://react-styleguidist.js.org/docs/webpack.html): tell Styleguidist how to load your code
- [Cookbook](https://react-styleguidist.js.org/docs/cookbook.html): how to solve common tasks with Styleguidist
- **[Getting Started](https://react-styleguidist.js.org/docs/getting-started): install and run Styleguidist**
- [Documenting components](https://react-styleguidist.js.org/docs/documenting): how to write documentation
- [Locating components](https://react-styleguidist.js.org/docs/components): point Styleguidist to your React components
- [Configuring webpack](https://react-styleguidist.js.org/docs/webpack): tell Styleguidist how to load your code
- [Cookbook](https://react-styleguidist.js.org/docs/cookbook): how to solve common tasks with Styleguidist

## Advanced documentation

- [Configuration](https://react-styleguidist.js.org/docs/configuration.html)
- [CLI commands and options](https://react-styleguidist.js.org/docs/cli.html)
- [Node.js API](https://react-styleguidist.js.org/docs/api.html)
- [Configuration](https://react-styleguidist.js.org/docs/configuration)
- [CLI commands and options](https://react-styleguidist.js.org/docs/cli)
- [Node.js API](https://react-styleguidist.js.org/docs/api)

## Examples

Expand All @@ -48,7 +48,7 @@ Real projects using React Styleguidist:

## Integration with other tools

- Create React App — supported out of the box, see the [Getting Started](https://react-styleguidist.js.org/docs/getting-started.html) guide
- Create React App — supported out of the box, see the [Getting Started](https://react-styleguidist.js.org/docs/getting-started) guide
- Vue, see [Vue Styleguidist](https://github.com/vue-styleguidist/vue-styleguidist)

## Third-party tools
Expand All @@ -70,7 +70,7 @@ The change log can be found on the [Releases page](https://github.com/styleguidi

## Contributing

Everyone is welcome to contribute. Please take a moment to read the [contributing guidelines](.github/Contributing.md) and the [developer guide](https://react-styleguidist.js.org/docs/development.html).
Everyone is welcome to contribute. Please take a moment to read the [contributing guidelines](.github/Contributing.md) and the [developer guide](https://react-styleguidist.js.org/docs/development).

## Sponsoring

Expand Down
2 changes: 1 addition & 1 deletion docs/Cookbook.md
Expand Up @@ -573,7 +573,7 @@ if (process.env.NODE_ENV !== 'production') {
}
```

3. [Start your style guide server](https://react-styleguidist.js.org/docs/getting-started.html#3-start-your-style-guide) and open your browser’s developer tools console.
3. [Start your style guide server](https://react-styleguidist.js.org/docs/getting-started#3-start-your-style-guide) and open your browser’s developer tools console.

If you are using Jest for testing you can also use [jest-axe](https://github.com/nickcolley/jest-axe).

Expand Down
16 changes: 8 additions & 8 deletions docs/Readme.md
@@ -1,13 +1,13 @@
# React Styleguidist Documentation

- **[Getting Started](https://react-styleguidist.js.org/docs/getting-started.html): install and run Styleguidist**
- [Documenting components](https://react-styleguidist.js.org/docs/documenting.html): how to write documentation
- [Locating components](https://react-styleguidist.js.org/docs/components.html): point Styleguidist to your React components
- [Configuring webpack](https://react-styleguidist.js.org/docs/webpack.html): tell Styleguidist how to load your code
- [Cookbook](https://react-styleguidist.js.org/docs/cookbook.html): how to solve common tasks with Styleguidist
- **[Getting Started](https://react-styleguidist.js.org/docs/getting-started): install and run Styleguidist**
- [Documenting components](https://react-styleguidist.js.org/docs/documenting): how to write documentation
- [Locating components](https://react-styleguidist.js.org/docs/components): point Styleguidist to your React components
- [Configuring webpack](https://react-styleguidist.js.org/docs/webpack): tell Styleguidist how to load your code
- [Cookbook](https://react-styleguidist.js.org/docs/cookbook): how to solve common tasks with Styleguidist

---

- [Configuration](https://react-styleguidist.js.org/docs/configuration.html)
- [CLI commands and options](https://react-styleguidist.js.org/docs/cli.html)
- [Node.js API](https://react-styleguidist.js.org/docs/api.html)
- [Configuration](https://react-styleguidist.js.org/docs/configuration)
- [CLI commands and options](https://react-styleguidist.js.org/docs/cli)
- [Node.js API](https://react-styleguidist.js.org/docs/api)
2 changes: 1 addition & 1 deletion examples/basic/src/components/Button/Readme.md
Expand Up @@ -72,7 +72,7 @@ import Placeholder from 'rsg-example/components/Placeholder'
</Button>
```

_Note: `rsg-example` module is an alias defined by the [moduleAliases](https://react-styleguidist.js.org/docs/configuration.html#modulealiases) config option._
_Note: `rsg-example` module is an alias defined by the [moduleAliases](https://react-styleguidist.js.org/docs/configuration#modulealiases) config option._

Each example's state can be accessed by React hook `useState`:

Expand Down
Expand Up @@ -17,7 +17,7 @@ Create **styleguide.config.js** file in your project root directory like this:
components: 'src/components/**/*.js'
};
Read more in the [locating components guide](https://react-styleguidist.js.org/docs/components.html).
Read more in the [locating components guide](https://react-styleguidist.js.org/docs/components).
"
/>
</div>
Expand Down
10 changes: 5 additions & 5 deletions src/scripts/consts.ts
@@ -1,7 +1,7 @@
export const HOMEPAGE = 'https://react-styleguidist.js.org/';
export const BUGS = 'https://github.com/styleguidist/react-styleguidist/issues';
export const DOCS_CONFIG = 'https://react-styleguidist.js.org/docs/configuration.html';
export const DOCS_COMPONENTS = 'https://react-styleguidist.js.org/docs/components.html';
export const DOCS_WEBPACK = 'https://react-styleguidist.js.org/docs/webpack.html';
export const DOCS_DOCUMENTING = 'https://react-styleguidist.js.org/docs/documenting.html';
export const DOCS_THIRDPARTIES = 'https://react-styleguidist.js.org/docs/thirdparties.html';
export const DOCS_CONFIG = 'https://react-styleguidist.js.org/docs/configuration';
export const DOCS_COMPONENTS = 'https://react-styleguidist.js.org/docs/components';
export const DOCS_WEBPACK = 'https://react-styleguidist.js.org/docs/webpack';
export const DOCS_DOCUMENTING = 'https://react-styleguidist.js.org/docs/documenting';
export const DOCS_THIRDPARTIES = 'https://react-styleguidist.js.org/docs/thirdparties';

0 comments on commit e662394

Please sign in to comment.