@compiiile/compiiile 2.7.4 → 2.8.0

package/.compiiile/src/pages/robots.txt.js

@@ -0,0 +1,14 @@
+const robotsTxt = `
+User-agent: *
+${JSON.parse(process.env.VITE_COMPIIILE_NO_INDEX) ? "Disallow: /" : "Allow: /"}
+
+${import.meta.env.SITE ? `Sitemap: ${new URL("sitemap-index.xml", import.meta.env.SITE).href}` : ""}
+`.trim()
+
+export const GET = () => {
+	return new Response(robotsTxt, {
+		headers: {
+			"Content-Type": "text/plain; charset=utf-8"
+		}
+	})
+}

package/README.md

@@ -186,6 +186,7 @@ Here is the list of parameters that you can set to customize Compiiile (none are
 | `data`                 | `Object`   | An object with data to use in MDX files (check use case below)                                                       |
 | `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`         |
 | `vite.server.fs.allow` | `string[]` | Add local paths to vite's server fs allow list                                                                       |
 
 You can use these parameters in 2 ways:

package/bin/config.js

@@ -8,6 +8,7 @@ import { copyFileSync, cpSync } from "node:fs"
 import markdownConfig from "./vitePluginCompiiile/markdownConfig.js"
 import resolvePackagePath from "resolve-package-path"
 import requireg from "requireg"
+import sitemap from "@astrojs/sitemap"
 
 const source = process.cwd()
 process.env.COMPIIILE_SOURCE = source
@@ -46,6 +47,7 @@ const argv = yargs(hideBin(process.argv))
 	.version(packageJSON.version).argv
 
 process.env.VITE_COMPIIILE_SITE_URL = argv.siteUrl ?? ""
+process.env.VITE_COMPIIILE_NO_INDEX = /true/i.test(argv.noIndex) // defaults to `false` if not set or not equal to `true`
 
 process.env.VITE_COMPIIILE_TITLE = argv.title ?? ""
 process.env.VITE_COMPIIILE_DESCRIPTION = argv.description ?? ""
@@ -87,7 +89,7 @@ if (packageDir) {
 
 const resolve = (mod) => {
 	const resolvedModule = requireg.resolve("vue")
-	const packagePath = resolvePackagePath(mod,resolvedModule)
+	const packagePath = resolvePackagePath(mod, resolvedModule)
 	return packagePath.slice(0, packagePath.lastIndexOf("/"))
 }
 
@@ -96,7 +98,13 @@ const astroConfig = {
 	srcDir: new URL("../.compiiile/src", import.meta.url).pathname,
 	outDir: path.join(source, argv.dest || ".compiiile/dist"),
 	...(argv.logo ? { publicDir } : {}),
-	integrations: [vue({ appEntrypoint: "/src/app.js" }), ...(configFromFile.integrations ?? []), mdx()],
+	integrations: [
+		vue({ appEntrypoint: "/src/app.js" }),
+		...(configFromFile.integrations ?? []),
+		mdx(),
+		...(process.env.VITE_COMPIIILE_SITE_URL ? [sitemap()] : [])
+	],
+	...(process.env.VITE_COMPIIILE_SITE_URL ? { site: process.env.VITE_COMPIIILE_SITE_URL } : {}),
 	vite: {
 		plugins: [compiiile()],
 		resolve: {

package/bin/vitePluginCompiiile/models/Context.js

@@ -63,7 +63,7 @@ export default class {
 
 		const files = fs.readdirSync(directoryPath).sort(collator.compare)
 
-		const entryFileMatcher = files.find((file) => file.toLowerCase() === "readme.md") ? /readme/ : /index/
+		const entryFileMatcher = files.find((file) => file.toLowerCase().match(/^readme.mdx?$/)) ? /readme/ : /index/
 
 		for (let file of files) {
 			if (

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@compiiile/compiiile",
 	"private": false,
-	"version": "2.7.4",
+	"version": "2.8.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,6 +22,7 @@
 	},
 	"dependencies": {
 		"@astrojs/mdx": "^2.1.1",
+		"@astrojs/sitemap": "^3.1.1",
 		"@astrojs/vue": "^4.0.8",
 		"@babel/core": "^7.0.0-0",
 		"@babel/eslint-parser": "^7.22.15",