Skip to content

docs(README): add anchor tags to options table #609

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.

Sign up for GitHub

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

Merged
michael-ciniawsky merged 2 commits into from
Sep 12, 2017
Merged

docs(README): add anchor tags to options table #609

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0cbb16
Improve docs usability
diegofaria Sep 10, 2017
afb0060
refactor links
diegofaria Sep 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,18 @@ It's useful when you, for instance, need to post process the CSS as a string.

|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|**`root`**|`{String}`|`/`|Path to resolve URLs, URLs starting with `/` will not be translated|
|**`url`**|`{Boolean}`|`true`| Enable/Disable `url()` handling|
|**`alias`**|`{Object}`|`{}`|Create aliases to import certain modules more easily|
|**`import`** |`{Boolean}`|`true`| Enable/Disable @import handling|
|**`modules`**|`{Boolean}`|`false`|Enable/Disable CSS Modules|
|**`minimize`**|`{Boolean\|Object}`|`false`|Enable/Disable minification|
|**`sourceMap`**|`{Boolean}`|`false`|Enable/Disable Sourcemaps|
|**`camelCase`**|`{Boolean\|String}`|`false`|Export Classnames in CamelCase|
|**`importLoaders`**|`{Number}`|`0`|Number of loaders applied before CSS loader|
|**[`root`](https://github.com/webpack-contrib/css-loader#root)**|`{String}`|`/`|Path to resolve URLs, URLs starting with `/` will not be translated|
Copy link
Member

@michael-ciniawsky michael-ciniawsky Sep 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea 👍 , but could you please check if [name](#root) works ?

Copy link
Contributor Author

@diegofaria diegofaria Sep 11, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, it works 😄

|**[`url`](https://github.com/webpack-contrib/css-loader#url)**|`{Boolean}`|`true`| Enable/Disable `url()` handling|
|**[`alias`](https://github.com/webpack-contrib/css-loader#alias)**|`{Object}`|`{}`|Create aliases to import certain modules more easily|
|**[`import`](https://github.com/webpack-contrib/css-loader#import)** |`{Boolean}`|`true`| Enable/Disable @import handling|
|**[`modules`](https://github.com/webpack-contrib/css-loader#modules)**|`{Boolean}`|`false`|Enable/Disable CSS Modules|
|**[`minimize`](https://github.com/webpack-contrib/css-loader#minimize)**|`{Boolean\|Object}`|`false`|Enable/Disable minification|
|**[`sourceMap`](https://github.com/webpack-contrib/css-loader#sourcemap)**|`{Boolean}`|`false`|Enable/Disable Sourcemaps|
|**[`camelCase`](https://github.com/webpack-contrib/css-loader#camelcase)**|`{Boolean\|String}`|`false`|Export Classnames in CamelCase|
|**[`importLoaders`](https://github.com/webpack-contrib/css-loader#importloaders)**|`{Number}`|`0`|Number of loaders applied before CSS loader|
|**`localIdentName`**|`{String}`|`[hash:base64]`|Configure the generated ident|


### `root`

For URLs that start with a `/`, the default behavior is to not translate them.
Expand Down