@compiiile/compiiile 2.10.2 → 2.11.0

package/.compiiile/.astro/settings.json

@@ -0,0 +1,5 @@
+{
+	"_variables": {
+		"lastUpdateCheck": 1718726455618
+	}
+}

package/README.md

@@ -207,6 +207,7 @@ Here is the list of parameters that you can set to customize Compiiile (none are
 | `theme`                | `string`   | The website theme, value can be : `auto` (default value: adapts to system preferences) \| `light` \| `dark`          |
 | `useAutoTitles`        | `Boolean`  | If set to `true`, use the first file heading as title to be displayed in the navbar and for SEO. Defaults to `false` |
 | `noIndex`              | `Boolean`  | If set to `true`, the `robots.txt` file will disallow all routes, preventing indexation. Defaults to `false`         |
+| `publicDir`            | `string`   | The folder name in which you can serve public files, defaults to `public`                                            |
 | `vite.server.fs.allow` | `string[]` | Add local paths to vite's server fs allow list                                                                       |
 
 You can use these parameters in 2 ways:
@@ -238,6 +239,17 @@ export default {
 
 > ⚠️ You should bear in mind that script arguments have priority over config file parameters.
 
+## Public files
+
+If you want some files to be public, just create a folder named `public` at the root of your Compiiile folder.
+
+For example, if you want to link to a local PDF in your Markdown file, you can put your PDF in your local public directory, in `public/my-pdf.pdf`.
+Then, all you have to do is creating a link in Markdown with an absolute path like so :
+
+```markdown
+[Check the PDF](/my-pdf.pdf)
+```
+
 ## Use MDX
 
 v2 of Compiiile allows you to use MDX files with Vue components.

package/bin/config.js

@@ -4,7 +4,7 @@ import { passthroughImageService } from "astro/config"
 import compiiile from "./vitePluginCompiiile/index.js"
 import mdx from "@astrojs/mdx"
 import path from "node:path"
-import { copyFileSync, cpSync } from "node:fs"
+import { copyFileSync, cpSync, existsSync } from "node:fs"
 import { fileURLToPath } from "node:url"
 import markdownConfig from "./vitePluginCompiiile/markdownConfig.js"
 import resolvePackagePath from "resolve-package-path"
@@ -88,6 +88,9 @@ const argv = yargs(hideBin(process.argv))
 		describe:
 			"If set to `true`, the `robots.txt` file will disallow all routes, preventing indexation. Defaults to `false`"
 	})
+	.option("publicDir", {
+		describe: "The folder name in which you can serve public files, defaults to `public`"
+	})
 	.option("vite.server.fs.allow", {
 		describe: "Add local paths to vite's server fs allow list"
 	})
@@ -112,9 +115,21 @@ process.env.VITE_COMPIIILE_LOGO = null
 
 const publicDir = path.resolve(source, "./.compiiile/public")
 
+const localPublicDirName = argv.publicDir ?? "public"
+const localPublicDir = path.resolve(source, localPublicDirName)
+const localPublicDirExists = existsSync(localPublicDir)
+
+const hasPublicFiles = localPublicDirExists || argv.logo
+if (hasPublicFiles) {
+	cpSync(fileURLToPath(new URL("../.compiiile/public", import.meta.url)), publicDir, { recursive: true })
+}
+
+if (localPublicDirExists) {
+	cpSync(localPublicDir, publicDir, { recursive: true })
+}
+
 if (argv.logo) {
 	try {
-		cpSync(fileURLToPath(new URL("../.compiiile/public", import.meta.url)), publicDir, { recursive: true })
 		copyFileSync(path.resolve(source, argv.logo), path.resolve(publicDir, "favicon.png"))
 		// Set the logo to be displayed on the top bar if we were able to copy
 		process.env.VITE_COMPIIILE_LOGO = argv.logo
@@ -139,7 +154,10 @@ const resolve = (mod) => {
 	const resolvedModule = requireg.resolve("vue")
 	const packagePath = resolvePackagePath(mod, resolvedModule)
 	// Check to work on both Windows (using `\`) and UNIX systems (using `/`)
-	return packagePath.slice(0, packagePath.lastIndexOf("/") < 0 ? packagePath.lastIndexOf("\\") : packagePath.lastIndexOf("/"))
+	return packagePath.slice(
+		0,
+		packagePath.lastIndexOf("/") < 0 ? packagePath.lastIndexOf("\\") : packagePath.lastIndexOf("/")
+	)
 }
 
 const astroConfig = {
@@ -150,7 +168,7 @@ const astroConfig = {
 	root: fileURLToPath(new URL("../.compiiile", import.meta.url)),
 	srcDir: fileURLToPath(new URL("../.compiiile/src", import.meta.url)),
 	outDir: path.join(source, argv.dest || ".compiiile/dist"),
-	...(argv.logo ? { publicDir } : {}),
+	...(hasPublicFiles ? { publicDir } : {}),
 	integrations: [
 		vue({ appEntrypoint: "/src/app.js" }),
 		...(configFromFile.integrations ?? []),

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@compiiile/compiiile",
 	"private": false,
-	"version": "2.10.2",
+	"version": "2.11.0",
 	"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",