From 0927303f38105c7e268f65bd4b3a100100e814ef Mon Sep 17 00:00:00 2001 From: Michael Altamirano Date: Sat, 1 Jan 2022 08:01:51 -0600 Subject: [PATCH] docs: update blobs, and svgo usage instructions (#659) --- packages/webpack/README.md | 2 +- website/pages/docs/configuration-files.mdx | 4 ++-- website/pages/docs/options.mdx | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/webpack/README.md b/packages/webpack/README.md index d83bd74d..a61d5f0a 100644 --- a/packages/webpack/README.md +++ b/packages/webpack/README.md @@ -83,7 +83,7 @@ If you prefer named export in any case, you may set the `exportType` option to ` ### Use your own Babel configuration -By default, `@svgr/webpack` includes a `babel-loader` with [an optimized configuration](https://github.com/gregberge/svgr/blob/master/packages/webpack/src/index.js). In some case you may want to apply a custom one (if you are using Preact for an example). You can turn off Babel transformation by specifying `babel: false` in options. +By default, `@svgr/webpack` includes a `babel-loader` with [an optimized configuration](https://github.com/gregberge/svgr/blob/main/packages/webpack/src/index.ts). In some case you may want to apply a custom one (if you are using Preact for an example). You can turn off Babel transformation by specifying `babel: false` in options. ```js // Example using preact diff --git a/website/pages/docs/configuration-files.mdx b/website/pages/docs/configuration-files.mdx index d0450e0f..ccc81e7e 100644 --- a/website/pages/docs/configuration-files.mdx +++ b/website/pages/docs/configuration-files.mdx @@ -53,9 +53,9 @@ expandProps: false ## SVGO -The recommended way to configure SVGO for SVGR is to use [`.svgo.yml`](https://github.com/svg/svgo/blob/master/.svgo.yml). [Several formats are supported](./packages/core/src/plugins/svgo.js) and it is relative to the transformed SVG file. +The recommended way to configure SVGO for SVGR is to use [`svgo.config.js`](https://github.com/svg/svgo/blob/main/README.md#configuration). -Even if it is not recommended, you can also use `svgoConfig` option to specify your SVGO configuration. `svgoConfig` has precedence on `.svgo.yml`. +Even if it is not recommended, you can also use `svgoConfig` option to specify your SVGO configuration. `svgoConfig` has precedence on `svgo.config.js`. ## Prettier diff --git a/website/pages/docs/options.mdx b/website/pages/docs/options.mdx index 975a0778..418d3f7c 100644 --- a/website/pages/docs/options.mdx +++ b/website/pages/docs/options.mdx @@ -180,11 +180,11 @@ Add title tag via title property. If titleProp is set to true and no title is pr ## Template -Specify a template file (CLI) or a template function (API) to use. For an example of template, see [the default one](https://github.com/gregberge/svgr/tree/master/packages/babel-plugin-transform-svg-component/src/index.js). +Specify a template file (CLI) or a template function (API) to use. For an example of template, see [the default one](https://github.com/gregberge/svgr/blob/main/packages/babel-plugin-transform-svg-component/src/defaultTemplate.ts). | Default | CLI Override | API Override | | ---------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------ | -| [`basic template`](https://github.com/gregberge/svgr/tree/master/packages/babel-plugin-transform-svg-component/src/index.js) | `--template` | `template: ` | +| [`basic template`](https://github.com/gregberge/svgr/blob/main/packages/babel-plugin-transform-svg-component/src/defaultTemplate.ts) | `--template` | `template: ` | ## Output Directory @@ -200,7 +200,7 @@ Specify a template function (API) to change default index.js output (when --out- | Default | CLI Override | API Override | | ------------------------------------------------------------------------------------------------ | ------------------ | -------------------------- | -| [`basic template`](https://github.com/gregberge/svgr/blob/master/packages/cli/src/dirCommand.js) | `--index-template` | indexTemplate: files => '' | +| [`basic template`](https://github.com/gregberge/svgr/blob/main/packages/cli/src/dirCommand.ts) | `--index-template` | indexTemplate: files => '' | ## index.js file