@compiiile/compiiile 2.15.0 → 2.16.0

package/.compiiile/components.d.ts

@@ -0,0 +1,23 @@
+/* eslint-disable */
+// @ts-nocheck
+// Generated by unplugin-vue-components
+// Read more: https://github.com/vuejs/core/pull/3399
+export {}
+
+/* prettier-ignore */
+declare module 'vue' {
+  export interface GlobalComponents {
+    ClientScript: typeof import('./src/components/ClientScript.vue')['default']
+    ContentWrapper: typeof import('./src/components/ContentWrapper.vue')['default']
+    FilesTree: typeof import('./src/components/layout/navBar/FilesTree.vue')['default']
+    HamburgerButton: typeof import('./src/components/layout/HamburgerButton.vue')['default']
+    NavBar: typeof import('./src/components/layout/navBar/NavBar.vue')['default']
+    NavListItem: typeof import('./src/components/layout/navBar/NavListItem.vue')['default']
+    SearchBar: typeof import('./src/components/searchBar/SearchBar.vue')['default']
+    SearchResult: typeof import('./src/components/searchBar/SearchResult.vue')['default']
+    SlidesContent: typeof import('./src/components/SlidesContent.vue')['default']
+    TableOfContent: typeof import('./src/components/TableOfContent.vue')['default']
+    ThemeSwitcher: typeof import('./src/components/layout/ThemeSwitcher.vue')['default']
+    TopBar: typeof import('./src/components/layout/TopBar.vue')['default']
+  }
+}

package/6-deploy.mdx

@@ -0,0 +1,42 @@
+---
+title: "Deploy"
+description: "Deploy a Compiiile project and self-host or put it online via a provider like Vercel, making your knowledge-base accessible on the web."
+---
+
+# Deploy Compiiile :rocket:
+
+You own your Markdown files, so unlike a proprietary solution, you can deploy Compiiile and make your knowledge-base accessible on the web freely.
+
+Let's suppose you have a folder containing a bunch Markdown files, with sub-folders, without any config file (no `package.json` whatsoever).
+It's a breeze to deploy it, so let's dive into it!
+
+## Self-host your knowledge-base :hammer:
+
+### Using Docker
+
+A [ready-to-use Docker file is available on the repo](https://github.com/compiiile/compiiile/blob/master/Dockerfile) and you can
+follow the [instructions on the README to build the files](./README.md#using-docker).
+
+### Build static files
+
+Assuming you have Compiiile installed globally (`npm install -g @compiiile/compiiile`), you can run the `build` command with parameters on-the-fly to generate static files.
+
+```bash
+compiiile build --title="Hello world!"
+```
+
+You'll have all your static files generated in the `.compiiile/dist` folder, ready to be served on your server!
+
+## Deploy your Markdown files on Vercel :globe_with_meridians:
+
+In your project's `Settings` tab, put these settings:
+- Framework preset: `Other`
+- Build command: `compiiile build --title="Hello world!"`
+- Output directory: `.compiiile/dist`
+- Install command: `npm install @compiiile/compiiile`
+
+Wait... is this it? Well, yeah, it's as simple as that! Everytime you make a new deployment (via a push to the `main` branch of your repo or via the Vercel CLI),
+you'll get your knowledge-base updated. Once again, without even config files! Isn't it beautiful? :open_mouth:
+
+> [!TIP]
+> Of course, something similar can be done using `Netlify`, `GitHub pages`, or whatever you use.

package/README.md

@@ -197,7 +197,7 @@ The home page of Compiiile (`/`) points to a `README.md` file located at the roo
 Here is the list of parameters that you can set to customize Compiiile (none are required):
 
 | Parameter              | Type       | Description                                                                                                          |
-| ---------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------- |
+|------------------------|------------|----------------------------------------------------------------------------------------------------------------------|
 | `title`                | `string`   | The title to display on the top-left of the User Interface                                                           |
 | `description`          | `string`   | The description that is rendered by default for the SEO                                                              |
 | `logo`                 | `string`   | The relative path of the logo to display in the TopBar and as favicon                                                |
@@ -211,6 +211,7 @@ Here is the list of parameters that you can set to customize Compiiile (none are
 | `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                                                                       |
+| `printReady`           | `Boolean`  | Add a `/print` page to display a full ready-to-print content (uses `@compiiile/compiiile-print`)                     |
 
 You can use these parameters in 2 ways:
 

package/bin/config.js

@@ -94,6 +94,9 @@ const argv = yargs(hideBin(process.argv))
 	.option("vite.server.fs.allow", {
 		describe: "Add local paths to vite's server fs allow list"
 	})
+	.option("printReady", {
+		describe: "Add a /print page to display a full ready-to-print content (uses @compiiile/compiiile-print)"
+	})
 	.help()
 	.version(packageJSON.version).argv
 
@@ -161,6 +164,13 @@ if (packageDir) {
 	viteServerFsAllowList.push(packageDir)
 }
 
+const localIntegrations = []
+
+if(/true/i.test(argv.printReady)){
+	const compiiilePrintIntegration = (await import("@compiiile/compiiile-print")).default
+	localIntegrations.push(compiiilePrintIntegration())
+}
+
 const astroConfig = {
 	server: {
 		host: argv.host,
@@ -173,6 +183,7 @@ const astroConfig = {
 	integrations: [
 		vue({ appEntrypoint: "/src/app.js" }),
 		...(configFromFile.integrations ?? []),
+		...(localIntegrations ?? []),
 		mdx(),
 		...(process.env.VITE_COMPIIILE_SITE_URL ? [sitemap()] : []),
 		{

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@compiiile/compiiile",
 	"private": false,
-	"version": "2.15.0",
+	"version": "2.16.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",
@@ -22,19 +22,20 @@
 		"url": "git+https://github.com/compiiile/compiiile.git"
 	},
 	"dependencies": {
-		"@astrojs/mdx": "^4.0.2",
+		"@astrojs/mdx": "^4.0.8",
 		"@astrojs/sitemap": "^3.2.1",
-		"@astrojs/vue": "^5.0.1",
+		"@astrojs/vue": "^5.0.6",
 		"@babel/core": "^7.26.0",
 		"@babel/eslint-parser": "^7.25.9",
 		"@babel/parser": "^7.26.3",
-		"@compiiile/compiiile-pro": "^1.1.8",
+		"@compiiile/compiiile-print": "^1.0.6",
+		"@compiiile/compiiile-pro": "^1.1.9",
 		"@eslint/compat": "^1.2.4",
 		"@eslint/js": "^9.16.0",
 		"@fontsource-variable/archivo": "^5.1.0",
 		"@fontsource-variable/dm-sans": "^5.1.0",
 		"@fontsource-variable/jetbrains-mono": "^5.1.1",
-		"astro": "^5.0.4",
+		"astro": "^5.2.5",
 		"astro-seo": "^0.8.4",
 		"c12": "^2.0.1",
 		"entities": "^5.0.0",
@@ -58,7 +59,7 @@
 		"typescript": "^5.7.2",
 		"uuid": "^11.0.3",
 		"vfile-matter": "^5.0.0",
-		"vite": "^6.0.3",
+		"vite": "^6.1.0",
 		"vue": "^3.5.13",
 		"yargs": "^17.7.2",
 		"zod": "^3.23.8"