You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-8Lines changed: 23 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -6,29 +6,44 @@ The [master](https://github.com/DefinitelyTyped/definitelytyped.github.io/tree/m
6
6
7
7
The site build with [Grunt](http://www.gruntjs.com) and generated using [docpad](http://docpad.org), a static site generator complete with watch tasks, development server with LiveReload and [many plugins](http://docpad.org/docs/plugins). Publishing happens using [grunt-gh-pages](https://github.com/tschaub/grunt-gh-pages).
8
8
9
-
10
9
## How to edit
11
10
12
-
1. Have the grunt global cli command `$ npm install grunt-cli -g`
11
+
Working with the site is done using your commandline terminal and should work on any platform. So it can be bash or shell or cmd.exe or anything else (like WebStorm embedded terminal).
12
+
13
+
Prerequisites:
14
+
15
+
1. Get [node.js](http://nodejs.org/) (`> 0.10.0`) for your local platform, it comes with the `npm` package manager.
16
+
17
+
1. Have the global grunt cli command: run `npm install grunt-cli -g` in your command line.
18
+
19
+
Get the project
13
20
14
21
1. Checkout and update the `source` branch.
15
22
16
-
1. Run `$ npm install` to pull all local dependencies.
23
+
1. Run `npm install` to pull all local dependencies. (this can take a minute)
24
+
25
+
Work in the project
17
26
18
27
1. Use grunt to execute tasks. The main command are:
19
28
20
-
1. `$ grunt clean` - drop all generated content.
29
+
1. Run `grunt clean` - drop all generated content.
21
30
22
-
1. `$ grunt watch` - regenerate and start a watch with LiveReload server at [http://localhost:9778/](http://localhost:9778/)
31
+
1. Run `grunt watch` - regenerate and start a watch with LiveReload server at [http://localhost:9778/](http://localhost:9778/)
23
32
24
-
1. `$ grunt build` - regenerate the site for production environment .
33
+
1. Run `grunt build` - regenerate the site for production environment .
25
34
26
-
1. `$ grunt publish` - build and push to github `master` (live at [definitelytyped.github.io](http://definitelytyped.github.io/)). This will ask for your github credentials. You need commit access to the repository. Don't forget to push your `source` branch too!
35
+
1. Run `grunt publish` - build and push to github `master` (live at [definitelytyped.github.io](http://definitelytyped.github.io/)). This will ask for your github credentials. You need commit access to the repository. Don't forget to push your `source` branch too!
27
36
28
-
1. See `$ grunt -h` or the `Gruntfile.js` for additional commands.
37
+
1. See `grunt -h` or the `Gruntfile.js` for additional commands.
29
38
30
39
:warning: Direct changes to `master` branch will be overwritten or discarded so always edit through `source`!
31
40
41
+
Notes:
42
+
43
+
1. You don't need a global docpad install, it comes as local dependency.
44
+
45
+
1. If you build or watch the content then you might get some yellow `warning`'s in the console. These can usually be ignored as it is docpad telling us that some transforms didn't have any effect: this is correct if you use a template transform (`.eco`) but have no template fields in the file (*yet*).
46
+
32
47
## Contributions
33
48
34
49
At some point we'll take contributions; it will probably involve sending a Pull Request on the `source` branch.
0 commit comments