@compiiile/compiiile 2.7.1 → 2.7.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Dockerfile +11 -0
- package/README.md +16 -7
- package/bin/config.js +19 -1
- package/package.json +5 -5
package/Dockerfile
ADDED
package/README.md
CHANGED
|
@@ -49,15 +49,14 @@ You can install Compiiile either globally or per-project:
|
|
|
49
49
|
|
|
50
50
|
### Globally
|
|
51
51
|
|
|
52
|
-
Open a terminal and type
|
|
53
|
-
or [yarn](https://yarnpkg.com/) depending on which package manager you are using:
|
|
52
|
+
Open a terminal and type the following command:
|
|
54
53
|
|
|
55
54
|
```bash
|
|
56
|
-
yarn global add @compiiile/compiiile # install globally with yarn
|
|
57
|
-
# or
|
|
58
55
|
npm install -g @compiiile/compiiile # install globally with npm
|
|
59
56
|
```
|
|
60
57
|
|
|
58
|
+
> Global installation won't work using `yarn` because modules are not resolved the same way.
|
|
59
|
+
|
|
61
60
|
### Per-project
|
|
62
61
|
|
|
63
62
|
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
|
|
|
69
68
|
npm install @compiiile/compiiile # install as a project dependency with npm
|
|
70
69
|
```
|
|
71
70
|
|
|
71
|
+
### Using Docker
|
|
72
|
+
|
|
73
|
+
First, copy the `./Dockerfile` from this repo to your root folder.
|
|
74
|
+
|
|
75
|
+
Run the following commands :
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
docker build -t <custom-image-name> .
|
|
79
|
+
docker run -p 8080:80 <custom-image-name>
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
> Replace `<custom-image-name>` with the tag you want.
|
|
83
|
+
|
|
72
84
|
## Quick start
|
|
73
85
|
|
|
74
86
|
To make yourself an idea and quickly get started using Compiiile, here are some commands that you can run in your
|
|
@@ -209,9 +221,6 @@ export default {
|
|
|
209
221
|
|
|
210
222
|
v2 of Compiiile allows you to use MDX files with Vue components.
|
|
211
223
|
|
|
212
|
-
For it to work, you should install some dependencies in your project folder: `yarn add vue astro fzf` (
|
|
213
|
-
or `npm install vue astro fzf`).
|
|
214
|
-
|
|
215
224
|
### Using components
|
|
216
225
|
|
|
217
226
|
Let's say we have Vue a component `Test.vue` making an API request and listing results:
|
package/bin/config.js
CHANGED
|
@@ -93,7 +93,25 @@ const astroConfig = {
|
|
|
93
93
|
plugins: [compiiile()],
|
|
94
94
|
resolve: {
|
|
95
95
|
alias: {
|
|
96
|
-
"@source": source
|
|
96
|
+
"@source": source,
|
|
97
|
+
|
|
98
|
+
// Adding aliases for Compiiile's build command to work when installed globally
|
|
99
|
+
vue: path.join(new URL("../node_modules/vue", import.meta.url).pathname),
|
|
100
|
+
"@vue/server-renderer": path.join(
|
|
101
|
+
new URL("../node_modules/@vue/server-renderer", import.meta.url).pathname
|
|
102
|
+
),
|
|
103
|
+
"@vue/runtime-dom": path.join(new URL("../node_modules/@vue/runtime-dom", import.meta.url).pathname),
|
|
104
|
+
"@vue/runtime-core": path.join(new URL("../node_modules/@vue/runtime-core", import.meta.url).pathname),
|
|
105
|
+
kleur: path.join(new URL("../node_modules/kleur", import.meta.url).pathname),
|
|
106
|
+
clsx: path.join(new URL("../node_modules/clsx", import.meta.url).pathname),
|
|
107
|
+
"html-escaper": path.join(new URL("../node_modules/html-escaper", import.meta.url).pathname),
|
|
108
|
+
cssesc: path.join(new URL("../node_modules/cssesc", import.meta.url).pathname),
|
|
109
|
+
"@vue/reactivity": path.join(new URL("../node_modules/@vue/reactivity", import.meta.url).pathname),
|
|
110
|
+
"@vue/shared": path.join(new URL("../node_modules/@vue/shared", import.meta.url).pathname),
|
|
111
|
+
fzf: path.join(new URL("../node_modules/fzf", import.meta.url).pathname),
|
|
112
|
+
"@astrojs/internal-helpers": path.join(
|
|
113
|
+
new URL("../node_modules/@astrojs/internal-helpers/dist", import.meta.url).pathname
|
|
114
|
+
)
|
|
97
115
|
}
|
|
98
116
|
},
|
|
99
117
|
server: {
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@compiiile/compiiile",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "2.7.
|
|
4
|
+
"version": "2.7.3",
|
|
5
5
|
"description": "The most convenient way to render a folder containing markdown files. Previewing and searching markdown files has never been that easy.",
|
|
6
6
|
"author": "AlbanCrepel <alban.crepel@gmail.com>",
|
|
7
7
|
"license": "GPL-3.0-only",
|
|
8
8
|
"type": "module",
|
|
9
9
|
"bin": {
|
|
10
|
-
"compiiile": "bin/cli.js"
|
|
10
|
+
"compiiile": "./bin/cli.js"
|
|
11
11
|
},
|
|
12
12
|
"scripts": {
|
|
13
13
|
"dev": "node ./bin/cli.js dev",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"@fontsource-variable/archivo": "^5.0.16",
|
|
29
29
|
"@fontsource-variable/dm-sans": "^5.0.3",
|
|
30
30
|
"@fontsource-variable/jetbrains-mono": "^5.0.18",
|
|
31
|
-
"astro": "^4.3
|
|
31
|
+
"astro": "^4.4.3",
|
|
32
32
|
"astro-seo": "^0.8.0",
|
|
33
33
|
"eslint": "^8.51.0",
|
|
34
34
|
"eslint-config-prettier": "^9.0.0",
|
|
@@ -46,8 +46,8 @@
|
|
|
46
46
|
"slugify": "^1.6.6",
|
|
47
47
|
"uuid": "^9.0.1",
|
|
48
48
|
"vfile-matter": "^5.0.0",
|
|
49
|
-
"vite": "^5.1.
|
|
50
|
-
"vue": "^3.4.
|
|
49
|
+
"vite": "^5.1.4",
|
|
50
|
+
"vue": "^3.4.19",
|
|
51
51
|
"yargs": "^17.7.2",
|
|
52
52
|
"zod": "^3.22.3"
|
|
53
53
|
},
|