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

Commit 95c2c20

Browse files
committed
build: add Dockerfile
1 parent 6350d9e commit 95c2c20

File tree

3 files changed

+27
-2
lines changed

3 files changed

+27
-2
lines changed

.dockerignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
npm-debug.log

Dockerfile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
FROM node:dubnium-alpine
2+
3+
WORKDIR /usr/src/app
4+
5+
# install dependencies
6+
COPY package.json .
7+
RUN npm install
8+
9+
# install the app
10+
COPY . .
11+
12+
EXPOSE 4567
13+
CMD [ "npm", "run", "serve" ]

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Version numbers of Shins aim to track the version of Slate they are compatible w
3131
* To specify a different output filename from the default `./index.html`, use the `--output` or `-o` option.
3232
* To allow css-style attributes in markdown, specify the `--attr` option.
3333
* 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.
3535
* Add, commit and push
3636
* Then (in your fork) press this button
3737

@@ -54,6 +54,16 @@ If you use the option `--minify` to shins, the only things you need to take to y
5454

5555
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.
5656

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+
5767
### Multiple Shins pages / portal
5868

5969
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.
114124
### Notes
115125

116126
* 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)
118128
* Multiple language tabs per language are supported
119129
* Static TOC as per Slate v2.0
120130
* [GitHub emoji shortcuts](https://gist.github.com/rxaviers/7360908) are supported

0 commit comments

Comments
 (0)