@compiiile/compiiile 2.12.0 → 2.13.1
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/README.md
CHANGED
|
@@ -183,7 +183,7 @@ Other frontmatter keys are handled:
|
|
|
183
183
|
- `textAlign`: possible values
|
|
184
184
|
are [CSS text-align values](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) (`left`, `center`, ...). This
|
|
185
185
|
changes the default text alignment in slides. The default value is `center`.
|
|
186
|
-
-
|
|
186
|
+
- `ignore` : Boolean value (`true` or `false`) to ignore the current file and exclude it from Compiiile (the file is not ignored by default).
|
|
187
187
|
|
|
188
188
|
> :bulb: You can override slides theme by passing it to a `theme` query parameter in your slide url (for example `/s/slides?theme=light`). See the `theme` config parameter below for valid values.
|
|
189
189
|
|
|
@@ -240,6 +240,8 @@ export default {
|
|
|
240
240
|
|
|
241
241
|
> ⚠️ You should bear in mind that script arguments have priority over config file parameters.
|
|
242
242
|
|
|
243
|
+
> :bulb: Compiiile uses [c12](https://github.com/unjs/c12) to load the config file, which allows to **extend config values** from other files. See the [dedicated c12 documentation](https://github.com/unjs/c12?tab=readme-ov-file#extending-configuration) for more information.
|
|
244
|
+
|
|
243
245
|
## Public files
|
|
244
246
|
|
|
245
247
|
If you want some files to be public, just create a folder named `public` at the root of your Compiiile folder.
|
|
@@ -340,12 +342,16 @@ keep this project really simple and straightforward).
|
|
|
340
342
|
|
|
341
343
|
You can read more about it and the roadmap in the [dedicated contributing guide](./CONTRIBUTING.md).
|
|
342
344
|
|
|
343
|
-
##
|
|
345
|
+
## Official integrations & community projects
|
|
346
|
+
|
|
347
|
+
You can add features to Compiiile by using the following projects:
|
|
348
|
+
|
|
349
|
+
- [compiiile-pro](https://compiiile.me/c/3-pro-installation): Enhance your Markdown files, add diagrams, mindmaps, admonitions, and ready-made components
|
|
350
|
+
- [compiiile-print](https://github.com/compiiile/compiiile-print): Add a print ready page containing all your Markdown files
|
|
344
351
|
|
|
345
352
|
Here is a list of projects related to Compiiile developed by the community:
|
|
346
353
|
|
|
347
|
-
- [compiiile-actions-cloudflare-pages](https://github.com/marketplace/actions/compiiile-cloudflare-pages): A simple
|
|
348
|
-
GitHub action to deploy a Compiiile site to CloudFlare pages
|
|
354
|
+
- [compiiile-actions-cloudflare-pages](https://github.com/marketplace/actions/compiiile-cloudflare-pages): A simple GitHub action to deploy a Compiiile site to CloudFlare pages
|
|
349
355
|
|
|
350
356
|
## Support
|
|
351
357
|
|
|
@@ -359,8 +365,8 @@ You can always contact me for a custom use of this project and any licence issue
|
|
|
359
365
|
|
|
360
366
|
Thank you :heart:
|
|
361
367
|
|
|
362
|
-
##
|
|
368
|
+
## License
|
|
363
369
|
|
|
364
370
|
This project is licensed under the terms of the GNU General Public License v3.0.
|
|
365
371
|
|
|
366
|
-
See [
|
|
372
|
+
See [LICENSE.md](./LICENSE.md).
|
package/bin/config.js
CHANGED
|
@@ -10,12 +10,10 @@ import markdownConfig from "./vitePluginCompiiile/markdownConfig.js"
|
|
|
10
10
|
import resolvePackagePath from "resolve-package-path"
|
|
11
11
|
import requireg from "requireg"
|
|
12
12
|
import sitemap from "@astrojs/sitemap"
|
|
13
|
-
|
|
13
|
+
import { loadConfig } from "c12"
|
|
14
14
|
const source = process.cwd()
|
|
15
15
|
process.env.COMPIIILE_SOURCE = source
|
|
16
16
|
|
|
17
|
-
const CONFIG_FILE = "compiiile.config.js"
|
|
18
|
-
|
|
19
17
|
import yargs from "yargs/yargs"
|
|
20
18
|
import { hideBin } from "yargs/helpers"
|
|
21
19
|
|
|
@@ -30,7 +28,7 @@ const packageJSON = JSON.parse(await readFile(fileURLToPath(new URL("../package.
|
|
|
30
28
|
*/
|
|
31
29
|
let configFromFile = {}
|
|
32
30
|
try {
|
|
33
|
-
configFromFile = (await
|
|
31
|
+
configFromFile = (await loadConfig({ name: "compiiile" })).config
|
|
34
32
|
} catch {
|
|
35
33
|
// This means that no config file was provided: getting parameters from script parameters instead
|
|
36
34
|
}
|
|
@@ -110,7 +108,6 @@ process.env.VITE_COMPIIILE_THEME = argv.theme ?? "auto"
|
|
|
110
108
|
process.env.VITE_COMPIIILE_DATA = JSON.stringify(argv.data ?? {})
|
|
111
109
|
process.env.VITE_COMPIIILE_USE_AUTO_TITLES = /true/i.test(argv.useAutoTitles) // defaults to `false` if not set or not equal to `true`
|
|
112
110
|
|
|
113
|
-
|
|
114
111
|
// Get command and set env
|
|
115
112
|
const IS_DEV = argv._.length === 0 || argv._.includes("dev")
|
|
116
113
|
const IS_BUILD = argv._.includes("build")
|
|
@@ -124,7 +121,6 @@ if (IS_DEV) {
|
|
|
124
121
|
process.env.NODE_ENV = NODE_ENV_PRODUCTION
|
|
125
122
|
}
|
|
126
123
|
|
|
127
|
-
|
|
128
124
|
// Handling logo and favicon
|
|
129
125
|
process.env.VITE_COMPIIILE_LOGO = null
|
|
130
126
|
|
|
@@ -205,7 +201,7 @@ const astroConfig = {
|
|
|
205
201
|
kleur: resolve("kleur"),
|
|
206
202
|
clsx: resolve("clsx"),
|
|
207
203
|
"html-escaper": resolve("html-escaper"),
|
|
208
|
-
...(process.env.NODE_ENV === NODE_ENV_PRODUCTION ? {cssesc: resolve("cssesc")} : {}), // Not included in dev because of the 'module is not defined' error otherwise
|
|
204
|
+
...(process.env.NODE_ENV === NODE_ENV_PRODUCTION ? { cssesc: resolve("cssesc") } : {}), // Not included in dev because of the 'module is not defined' error otherwise
|
|
209
205
|
mrmime: resolve("mrmime"),
|
|
210
206
|
"@vue/reactivity": resolve("@vue/reactivity"),
|
|
211
207
|
"@vue/shared": resolve("@vue/shared"),
|
|
@@ -122,9 +122,9 @@ export default class {
|
|
|
122
122
|
|
|
123
123
|
const meta = renderedMarkdown.metadata.frontmatter
|
|
124
124
|
|
|
125
|
-
if(meta.ignore){
|
|
126
|
-
const fileIndex = fileArray.findIndex(f => f.uuid === fileListItem.uuid)
|
|
127
|
-
if(fileIndex > -1){
|
|
125
|
+
if (meta.ignore) {
|
|
126
|
+
const fileIndex = fileArray.findIndex((f) => f.uuid === fileListItem.uuid)
|
|
127
|
+
if (fileIndex > -1) {
|
|
128
128
|
fileArray.splice(fileIndex, 1)
|
|
129
129
|
}
|
|
130
130
|
continue
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@compiiile/compiiile",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.13.1",
|
|
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",
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
},
|
|
20
20
|
"repository": {
|
|
21
21
|
"type": "git",
|
|
22
|
-
"url": "git+https://github.com/
|
|
22
|
+
"url": "git+https://github.com/compiiile/compiiile.git"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
25
|
"@astrojs/mdx": "^2.3.1",
|
|
@@ -27,12 +27,13 @@
|
|
|
27
27
|
"@astrojs/vue": "^4.5.0",
|
|
28
28
|
"@babel/core": "^7.0.0-0",
|
|
29
29
|
"@babel/eslint-parser": "^7.22.15",
|
|
30
|
-
"@compiiile/compiiile-pro": "^1.1.
|
|
30
|
+
"@compiiile/compiiile-pro": "^1.1.5",
|
|
31
31
|
"@fontsource-variable/archivo": "^5.0.16",
|
|
32
32
|
"@fontsource-variable/dm-sans": "^5.0.3",
|
|
33
33
|
"@fontsource-variable/jetbrains-mono": "^5.0.18",
|
|
34
|
-
"astro": "^4.
|
|
34
|
+
"astro": "^4.12.3",
|
|
35
35
|
"astro-seo": "^0.8.4",
|
|
36
|
+
"c12": "^1.11.1",
|
|
36
37
|
"eslint": "^8.51.0",
|
|
37
38
|
"eslint-config-prettier": "^9.0.0",
|
|
38
39
|
"eslint-plugin-vue": "^9.17.0",
|
|
@@ -51,8 +52,8 @@
|
|
|
51
52
|
"slugify": "^1.6.6",
|
|
52
53
|
"uuid": "^9.0.1",
|
|
53
54
|
"vfile-matter": "^5.0.0",
|
|
54
|
-
"vite": "^5.3.
|
|
55
|
-
"vue": "^3.4.
|
|
55
|
+
"vite": "^5.3.5",
|
|
56
|
+
"vue": "^3.4.35",
|
|
56
57
|
"yargs": "^17.7.2",
|
|
57
58
|
"zod": "^3.22.3"
|
|
58
59
|
},
|
|
File without changes
|