@compiiile/compiiile 2.7.2 → 2.7.3

package/Dockerfile

@@ -0,0 +1,11 @@
+FROM node:lts AS build
+
+RUN npm install -g @compiiile/compiiile
+
+WORKDIR /app
+COPY . .
+CMD ["/usr/local/bin/compiiile", "build"]
+
+FROM httpd:2.4 AS runtime
+COPY --from=build /app/.compiiile/dist /usr/local/apache2/htdocs/
+EXPOSE 80

package/README.md

@@ -49,15 +49,14 @@ You can install Compiiile either globally or per-project:
 
 ### Globally
 
-Open a terminal and type one of these commands, whether using [npm](https://www.npmjs.com/)
-or [yarn](https://yarnpkg.com/) depending on which package manager you are using:
+Open a terminal and type the following command:
 
 ```bash
-yarn global add @compiiile/compiiile # install globally with yarn
-# or
 npm install -g @compiiile/compiiile # install globally with npm
 ```
 
+> Global installation won't work using `yarn` because modules are not resolved the same way.
+
 ### Per-project
 
 Open a terminal inside the folder containing your markdown files. Then, add Compiiile as a local command using yarn or
@@ -69,6 +68,19 @@ yarn add @compiiile/compiiile # install as a project dependency with yarn
 npm install @compiiile/compiiile # install as a project dependency with npm
 ```
 
+### Using Docker
+
+First, copy the `./Dockerfile` from this repo to your root folder.
+
+Run the following commands :
+
+```bash
+docker build -t <custom-image-name> .
+docker run -p 8080:80 <custom-image-name>
+```
+
+> Replace `<custom-image-name>` with the tag you want.
+
 ## Quick start
 
 To make yourself an idea and quickly get started using Compiiile, here are some commands that you can run in your

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@compiiile/compiiile",
 	"private": false,
-	"version": "2.7.2",
+	"version": "2.7.3",
 	"description": "The most convenient way to render a folder containing markdown files. Previewing and searching markdown files has never been that easy.",
 	"author": "AlbanCrepel <alban.crepel@gmail.com>",
 	"license": "GPL-3.0-only",