Skip to content

Commit 1f34062

Browse files
authored
Merge pull request #6396 from Piterden/fix/src-readme-formatting
Fixed some formatting
2 parents 185b320 + ec7e089 commit 1f34062

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

src/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,20 @@
33
### Built-In Tools
44

55
From the Semantic directory you can setup gulp to build Semantic by running.
6+
67
```bash
78
npm install
89
```
910

1011
Semantic will automatically configure itself using a `post-install` script built into the package.
1112

1213
After set-up can use gulp to build your project's css:
14+
1315
```bash
14-
/* Watch files */
16+
# Watch files
1517
gulp watch
1618

17-
/* Build all files */
19+
# Build all files
1820
gulp build
1921
```
2022

@@ -27,9 +29,8 @@ Visit the [Getting Started Guide](http://learnsemantic.com/guide/expert.html) fo
2729
Each gulp task can be imported into your own Gulpfile using `require`
2830

2931
```javascript
30-
var
31-
watch = require('path/to/semantic/tasks/watch')
32-
;
32+
const watch = require('path/to/semantic/tasks/watch');
33+
3334
gulp.task('watch ui', 'Watch Semantic UI', watch));
3435
```
3536

@@ -40,12 +41,14 @@ gulp.task('watch ui', 'Watch Semantic UI', watch));
4041
Before using source files you will need to create a `theme.config` by renaming `theme.config.example`, and a site folder by renaming `_site/` to `site/`
4142

4243
You can then import Semantic from your own LESS files:
44+
4345
```less
4446
/* Import all components */
4547
@import 'src/semantic';
4648
```
4749

4850
To import individual components you will have to create a scope for each import using `& {}`
51+
4952
```less
5053
/* Import a specific component */
5154
& { @import 'src/definitions/elements/button'; }
@@ -61,7 +64,6 @@ filename | usage | Initial Name
6164
**site/** | folder storing all your site's variables and css overrides for each UI component | _site/
6265
**semantic.json** | stores folder paths for build tools and current installed version for updates. Only necessary when using build tools | semantic.json.example
6366

64-
6567
### Workflow
6668

6769
You will only need to use Semantic's build tools while refining your UI. When designing pages, you can rely on the compiled css packages in `dist/`.
@@ -119,9 +121,9 @@ You may also specify your own custom LESS in `site/elements/button.overrides`. T
119121
You can modify `theme.config` to use any prepackaged theme available in `src/themes/`.
120122

121123
For example you can modify `theme.config` to use a `github` button theme by changing
124+
122125
```less
123126
@button: 'github';
124127
```
125128

126129
View the [Customization Guide](http://learnsemantic.com/developing/customizing.html) to learn more
127-

0 commit comments

Comments
 (0)