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
{{ message }}
This repository was archived by the owner on Feb 24, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Version numbers of Shins aim to track the version of Slate they are compatible w
31
31
* To specify a different output filename from the default `./index.html`, use the `--output` or `-o` option.
32
32
* To allow css-style attributes in markdown, specify the `--attr` option.
33
33
* You can specify another location for the `source` and `pub` directories using the `--root` option.
34
-
* To check locally: `node arapaho` or `npm run start` and browse to [localhost:4567](http://localhost:4567) - changes to your source `.html.md` files and the `source/includes` directory will automatically be picked up and re-rendered. If you use `--launch` or `-l` your default browser will be opened automatically. You can also pass `shins` options on the `arapaho` command-line.
34
+
* To check locally: `node arapaho` or `npm run serve` and browse to [localhost:4567](http://localhost:4567) - changes to your source `.html.md` files and the `source/includes` directory will automatically be picked up and re-rendered. If you use `--launch` or `-l` or `npm run start` your default browser will be opened automatically. You can also pass `shins` options on the `arapaho` command-line.
35
35
* Add, commit and push
36
36
* Then (in your fork) press this button
37
37
@@ -54,6 +54,16 @@ If you use the option `--minify` to shins, the only things you need to take to y
54
54
55
55
If you use the `--inline` option to shins, then everything is bundled into the `index.html` file and no `pub` directory is required. Fonts are by default loaded from this github repository, but this can be overridden with the `--fonturl` option.
56
56
57
+
### Docker
58
+
59
+
A `Dockerfile` is included. To build:
60
+
61
+
*`docker build . -t shins:latest`
62
+
63
+
to run:
64
+
65
+
*`docker run -p 4567:4567 shins:latest`
66
+
57
67
### Multiple Shins pages / portal
58
68
59
69
There is a simple example of using an [index markdown file](./source/portal.html.md) as an entry point to a collection of Shins pages [here](https://mermade.github.io/shins/portal.html).
@@ -114,7 +124,7 @@ Set `logo-url` if you want the logo image to link to a webpage.
114
124
### Notes
115
125
116
126
* Windows is definitely supported
117
-
* Syntax highlighting in 176[languages](https://highlightjs.org/static/demo/) and 79[themes](https://highlightjs.org/static/demo/) (you can specify the highlighter theme to use by setting `highlight_theme` in your slate markdown header)
127
+
* Syntax highlighting in 189[languages](https://highlightjs.org/static/demo/) and 91[themes](https://highlightjs.org/static/demo/) (you can specify the highlighter theme to use by setting `highlight_theme` in your slate markdown header)
118
128
* Multiple language tabs per language are supported
119
129
* Static TOC as per Slate v2.0
120
130
*[GitHub emoji shortcuts](https://gist.github.com/rxaviers/7360908) are supported
0 commit comments