@compiiile/compiiile 2.13.4 → 2.14.1

package/.compiiile/.astro/settings.json

@@ -1,5 +1,5 @@
 {
 	"_variables": {
-		"lastUpdateCheck": 1724762294937
+		"lastUpdateCheck": 1725988838449
 	}
 }

package/.compiiile/src/components/ContentWrapper.vue

@@ -105,9 +105,15 @@
 				return this.fileIndex > -1 ? this.$context.fileList[this.fileIndex] : null
 			},
 			fileSiblings() {
+				let visibleFiles = this.$context.fileList
+				if (!this.file.meta.hidden) {
+					visibleFiles = visibleFiles.filter((file) => !file.meta.hidden)
+				}
+				const newIndex = visibleFiles.findIndex((file) => file.uuid === this.name)
+
 				return {
-					prev: this.$context.fileList[this.fileIndex - 1] ?? null,
-					next: this.$context.fileList[this.fileIndex + 1] ?? null
+					prev: visibleFiles[newIndex - 1] ?? null,
+					next: visibleFiles[newIndex + 1] ?? null
 				}
 			}
 		}
@@ -195,7 +201,7 @@
 			margin: 20px auto;
 			display: block;
 			object-fit: contain;
-            height: auto;
+			height: auto;
 		}
 
 		a {

package/.compiiile/src/components/layout/navBar/NavListItem.vue

@@ -1,5 +1,5 @@
 <template>
-	<li class="nav-list-item no-wrap">
+	<li v-if="isVisible(item)" class="nav-list-item no-wrap">
 		<template v-if="item.isDirectory">
 			<svg
 				class="directory-icon"
@@ -156,6 +156,21 @@
 			route() {
 				return this.$context.routeList.find((route) => route.name === this.item.uuid)
 			}
+		},
+		methods: {
+			isVisible(item) {
+				if (!item.isDirectory) {
+					const route = this.$context.routeList.find((route) => route.name === item.uuid)
+					return !route.meta.hidden
+				}
+
+				return (
+					item.children.length > 0 &&
+					item.children.some((child) => {
+						return this.isVisible(child)
+					})
+				)
+			}
 		}
 	}
 </script>

package/README.md

@@ -184,6 +184,7 @@ Other frontmatter keys are handled:
     are [CSS text-align values](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) (`left`, `center`, ...). This
     changes the default text alignment in slides. The default value is `center`.
 -   `ignore` : Boolean value (`true` or `false`) to ignore the current file and exclude it from Compiiile (the file is not ignored by default).
+-   `hidden` : Boolean value (`true` or `false`) to hide the file from the navbar and siblings links (the file is not hidden by default).
 
 > :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.
 
@@ -323,6 +324,18 @@ import { site } from "virtual:compiiile"
 # {site.data.someProperty}
 ```
 
+## Ignoring files and folders
+
+To ignore a whole folder or some files matching a certain pattern, you can add a `.compiiileignore` at the root of the folder where you run Compiiile.
+
+This file accepts glob patterns to ignore files. For example, if you want to ignore files containing the word `preview` and files starting with a number,
+you can simply put these 2 lines in your `.compiiileignore`:
+
+```ignorelang
+*preview*
+[1-9]*
+```
+
 ## Common issues
 
 -   Make sure that the absolute path to the folder where you are running Compiiile doesn't contain any special character

package/bin/vitePluginCompiiile/models/Context.js

@@ -8,6 +8,8 @@ import { createMarkdownProcessor } from "@astrojs/markdown-remark"
 import markdownConfig from "../markdownConfig.js"
 import { unemojify } from "node-emoji"
 import slugify from "slugify"
+import parseIgnore from "parse-gitignore"
+import { minimatch } from "minimatch"
 
 export default class {
 	WORKSPACE_BASE_PATH = "c"
@@ -80,6 +82,27 @@ export default class {
 				].includes(file)
 			) {
 				const filePath = path.join(directoryPath, file)
+
+				try {
+					const compiiileIgnoreFilePath = fs.readFileSync(
+						path.join(process.env.COMPIIILE_SOURCE, ".compiiileignore")
+					)
+					const compiiileIgnore = parseIgnore(compiiileIgnoreFilePath)
+
+					const ignoreGlobs = compiiileIgnore.globs().filter((globType) => globType.type === "ignore")
+					const ignorePatterns = ignoreGlobs.reduce((patterns, currentIgnoreGlobItem) => {
+						return [...patterns, ...currentIgnoreGlobItem.patterns]
+					}, [])
+
+					const isFilePathInIgnoredPatterns = ignorePatterns.some((pattern) => minimatch(filePath, pattern))
+
+					if (isFilePathInIgnoredPatterns) {
+						continue
+					}
+				} catch (e) {
+					// No .compiiileignore file found at the root
+				}
+
 				const isDirectory = fs.statSync(filePath).isDirectory()
 				const uuid = uuidv4()
 				const fileName = path.parse(filePath).name

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@compiiile/compiiile",
 	"private": false,
-	"version": "2.13.4",
+	"version": "2.14.1",
 	"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",
@@ -39,7 +39,9 @@
 		"eslint-plugin-vue": "^9.17.0",
 		"fzf": "^0.5.2",
 		"hastscript": "^9.0.0",
+		"minimatch": "^10.0.1",
 		"node-emoji": "^2.1.0",
+		"parse-gitignore": "^2.0.0",
 		"pkg-dir": "^7.0.0",
 		"prettier": "^3.0.3",
 		"rehype-autolink-headings": "^7.1.0",