Skip to content
This repository was archived by the owner on Feb 21, 2025. It is now read-only.

Commit 2a7de92

Browse files
committed
feat(docs): improve it
1 parent 5eab4f2 commit 2a7de92

File tree

2 files changed

+28
-14
lines changed

2 files changed

+28
-14
lines changed

docs/usage.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
## Config
2+
3+
All is easily configurable by changing values in your `gulpfile.yml` file in your project. These values are merged into the `gulpfile.default.yml` file.
4+
5+
For example, you can enable SCSS and JS like this:
6+
```yml
7+
css:
8+
enabled: true
9+
js:
10+
enabled: true
11+
```
12+
13+
You can find all the available options and defaults settings inside the `gulpfile.default.yml` file.
14+
15+
116
## Commands
217

318
- `gulp` - Run all compile tasks, and watch for changes
@@ -18,17 +33,18 @@ All the documentation can be found inside the [Features](features/css.md) sectio
1833

1934
In order to use Babel, you need to create a `.babelrc` into your project, with the presets that you want installed.
2035

21-
!!! note "Example"
22-
Run:
23-
```bash
24-
$ npm install --save-dev babel-preset-es2015
25-
```
26-
And create a `.babelrc` file:
27-
```json
28-
{
29-
"presets": ["es2015"]
30-
}
31-
```
36+
**Example:**
37+
38+
Run:
39+
```bash
40+
$ npm install --save-dev babel-preset-es2015
41+
```
42+
And create a `.babelrc` file:
43+
```json
44+
{
45+
"presets": ["es2015"]
46+
}
47+
```
3248

3349
### ESLint
3450

mkdocs.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,9 @@ pages:
1414
- Troubleshooting: troubleshooting.md
1515

1616
markdown_extensions:
17-
- admonition
1817
- toc:
1918
permalink: True
20-
- mdx_sections
21-
- pymdownx.superfences
19+
- admonition:
2220

2321
extra_css:
2422
- extra.css

0 commit comments

Comments
 (0)