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
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,21 +10,21 @@ To use **onepunch**, you should have installed **node** and **npm** in your syst
10
10
11
11
Install **onepunch** globally with the following command:
12
12
13
-
```
13
+
```sh
14
14
$ npm install -g @nextbitlabs/onepunch
15
15
```
16
16
17
17
Please note that onepunch makes use of [puppeteer](https://github.com/puppeteer/puppeteer/), which will download chromium. This is necessary to print the PDF file.
18
18
19
19
Update **onepunch** to the latest release with:
20
20
21
-
```
21
+
```sh
22
22
$ npm update -g @nextbitlabs/onepunch
23
23
```
24
24
25
25
### Create a project
26
26
27
-
```
27
+
```sh
28
28
$ onepunch init [-n directory-name]
29
29
```
30
30
@@ -34,7 +34,7 @@ The command above creates the directory `directory-name` with all the files need
34
34
35
35
Inside the project directory, run:
36
36
37
-
```
37
+
```sh
38
38
$ onepunch serve
39
39
```
40
40
@@ -44,30 +44,30 @@ The command above starts a local server and opens the browser, use the arrow key
44
44
45
45
Inside the project directory, run:
46
46
47
-
```
47
+
```sh
48
48
$ onepunch print
49
49
```
50
50
51
51
### Update
52
52
53
53
Update files in the `src` directory according to the latest release of **onepunch**, please note that any custom change inside directory `src` will be overwritten:
54
54
55
-
```
55
+
```sh
56
56
$ onepunch update
57
57
```
58
58
59
59
The above command assumes you have installed the latest release of **onepunch**.
60
60
If this is not the case, update **onepunch** to the latest release with:
61
61
62
-
```
62
+
```sh
63
63
$ npm update -g @nextbitlabs/onepunch
64
64
```
65
65
66
66
### Create custom styles
67
67
68
68
Each slide is created by means of tag `article`, for example:
69
69
70
-
```
70
+
```html
71
71
<main>
72
72
73
73
<!-- Slides 1 -->
@@ -92,7 +92,7 @@ Each slide is created by means of tag `article`, for example:
92
92
93
93
As usual, designers can define CSS classes to apply custom style. For example, the following class defines a specific grid layout:
0 commit comments