Skip to content

Commit 58de1d4

Browse files
committed
brackets types of aliases
1 parent 99ff43d commit 58de1d4

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

readme.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -137,10 +137,10 @@ subImport([
137137
* Finally, we need to specify where script to look for a new file.
138138
* Here I am using aliases.
139139
* ~ - Reference to the root of current project
140-
* [folder] - Contains the base name of folder where import used.
140+
* <folder> - Contains the base name of folder where import used.
141141
* The use of this alias allows substitution for each component.
142142
*/
143-
to: '~/theme/components/[folder]/variable.css'
143+
to: '~/theme/components/<folder>/variable.css'
144144
}
145145
]);
146146
```
@@ -164,8 +164,8 @@ subImport([
164164
{
165165
// id: /variables\.css/,
166166
base: /components/,
167-
// to: '~/theme/components/[folder]/variable.css'
168-
path: '~/theme/components/[folder]'
167+
// to: '~/theme/components/<folder>/variable.css'
168+
path: '~/theme/components/<folder>'
169169
}
170170
]);
171171
```
@@ -213,9 +213,9 @@ Usage of approach of the regular expression is limited only by your imagination.
213213

214214
## Predefined template variables
215215

216-
- `[root]` Root directory of the project (process.cwd() by default);
217-
- `[id]` The string passed to import;
218-
- `[folder]` Base directory name.
216+
- `<root>`, `~` Root directory of the project (process.cwd() by default);
217+
- `<id>` The string passed to import;
218+
- `<folder>` Base directory name.
219219

220220
## Using original postcss-import options
221221

@@ -232,6 +232,16 @@ subImport({
232232

233233
If you wanna to specify your own `resolve` function, keep in mind that your function will be called only in case of failure of sub.
234234

235+
# Examples
236+
237+
__Color theme__
238+
```shell
239+
git clone https://github.com/morulus/postcss-import-sub.git
240+
cd postcss-import-sub/examples/colortheme
241+
npm install
242+
npm start
243+
```
244+
235245
# License
236246

237247
Under MIT license, 2016, Vladimir Kalmykov <[email protected]>

0 commit comments

Comments
 (0)