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

Commit fd389f8

Browse files
committed
feat(docs): improve it
1 parent cf7d236 commit fd389f8

File tree

9 files changed

+27
-8
lines changed

9 files changed

+27
-8
lines changed

docs/features/browser-sync.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ Create a connection between your desk and your website, using BrowserSync.
33
## Commands
44

55
- `gulp serve` - Launch Browsersync server
6+
7+
---

docs/features/css.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,5 @@ You can create individual CSS files bundle, using the config:
2424
- `config.css.lint` - Boolean for if Linting should occur
2525
- `config.css.sourceComments` - Boolean - Enable comments written in CSS that shows SCSS source. **Don't turn on permanently**, it's useful if SourceMaps aren't working.
2626
- `config.css.autoPrefixerBrowsers` - Array of [Browsers to Support](https://github.com/ai/browserslist#queries) for Autoprefixer (used by PostCSS).
27+
28+
---

docs/features/drupal-drush.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,8 @@ Launch a Drupal command.
1313
## Notes
1414

1515
If you want to use it with [Drucker](https://github.com/ovh-ux/drucker), you need to:
16+
1617
- set the `config.drupal.dir` to `./path/to/drucker`
1718
- set the `config.drupal.command` to `. load-env && drush cc all`
19+
20+
---

docs/features/icons.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,5 @@ Or this HTML class:
2727
- `config.icons.iconName` - Name of the icon (will be the name of the font)
2828
- `config.icons.classNamePrefix` - Icon class name prefix (default: "icon")
2929
- `config.icons.templates.css.dest` - The generated SCSS file
30+
31+
---

docs/features/js.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Compiles JS files using Babel. You can optionaly concat, uglify, and add sourcemaps.
22

33
!!! note ""
4-
It's recommanded to use [Webpack](features/webpack.md) instead.
4+
We recommand to use [Webpack](features/webpack.md) instead.
55

66
## Commands
77

@@ -10,3 +10,5 @@ Compiles JS files using Babel. You can optionaly concat, uglify, and add sourcem
1010
- `gulp validate:js` - Test JS with ESLINT
1111
- `gulp js:bundleBower` - (optional) compile, uglify, concat bower dependencies (result files will be `bower--*deps*.js`)
1212
- `gulp watch:bower` - (optional) Watch and compile bower deps
13+
14+
---

docs/features/webpack.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ You can then configure the JS bundles that you want:
1515

1616
- `gulp webpack` - Launch Webpack compilation
1717
- `gulp watch:webpack` - Watch and compile
18+
19+
---

docs/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@ $ vi gulpfile.yml
3838
# <set the config that you want, and save it>
3939
```
4040

41-
!!! note ""
42-
See the [Config](config.yml) section for the documentation about the configuration file.
43-
4441

4542
## Usage
4643

@@ -55,3 +52,5 @@ Original project from [p2-theme-core](https://github.com/phase2/p2-theme-core).
5552
## License
5653

5754
MIT (original license)
55+
56+
---

docs/troubleshooting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
---

docs/usage.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,18 @@
88

99
## Specifics Commands
1010

11-
You can launch specifics tasks, for example "lint CSS files". In this example, you can use `gulp validate:css`.
11+
You can launch specifics tasks, for example "lint CSS files": `gulp validate:css`.
1212

13-
All the documentation can be found inside the [Features](features) section.
13+
All the documentation can be found inside the [Features](features/css.md) section.
1414

15+
---
1516

1617
### Babel
1718

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

2021
**Example:**
22+
2123
Run:
2224
```bash
2325
$ npm install --save-dev babel-preset-es2015
@@ -29,11 +31,12 @@ And create a `.babelrc` file:
2931
}
3032
```
3133

32-
### ESLINT
34+
### ESLint
3335

3436
You need to create a `.eslintrc.js` file, and specify whitch rules that you want (`eslint-config-ovh` is recommanded).
3537

3638
**Example:**
39+
3740
Run:
3841
```bash
3942
$ npm install --save-dev babel-eslint
@@ -56,11 +59,12 @@ module.exports = {
5659
};
5760
```
5861

59-
### STYLELINT
62+
### StyleLint
6063

6164
You need to create a `.stylelintrc.js` file, and specify whitch rules that you want (`stylelint-config-ovh` is recommanded).
6265

6366
**Example:**
67+
6468
Run:
6569
```bash
6670
$ npm install --save-dev stylelint-scss
@@ -74,3 +78,5 @@ module.exports = {
7478
"extends": "stylelint-config-ovh/configs/scss"
7579
};
7680
```
81+
82+
---

0 commit comments

Comments
 (0)