@anydigital/11ty-bricks 1.0.0-alpha.10 → 1.0.0-alpha.12

package/README.md

@@ -589,6 +589,64 @@ The plugin also exports the following for advanced usage:
 - `transformAutoRaw(content)`: The transform function used by `mdAutoRawTags` preprocessor. Can be used programmatically to wrap Nunjucks syntax with raw tags.
 - `transformNl2br(content)`: The transform function used by `mdAutoNl2br` preprocessor. Can be used programmatically to convert `\n` sequences to `<br>` tags.
 
+## Starter Configuration Files
+
+The package includes pre-configured starter files in `node_modules/@anydigital/11ty-bricks/src/starter/` that you can symlink to your project for quick setup:
+
+### Available Starter Files
+
+#### eleventy.config.js
+
+A fully-configured Eleventy config file with:
+- All 11ty-bricks plugins enabled
+- Eleventy Navigation plugin
+- Markdown-it with anchors
+- YAML data support
+- CLI input directory support
+- Symlink support for development
+
+**Symlink to your project:**
+```bash
+ln -s node_modules/@anydigital/11ty-bricks/src/starter/eleventy.config.js eleventy.config.js
+```
+
+#### tailwind.config.js
+
+A pre-configured Tailwind CSS config optimized for Eleventy projects with proper content paths.
+
+**Symlink to your project:**
+```bash
+ln -s node_modules/@anydigital/11ty-bricks/src/starter/tailwind.config.js tailwind.config.js
+```
+
+#### admin/index.html
+
+A ready-to-use Sveltia CMS admin interface for content management.
+
+**Symlink to your project:**
+```bash
+mkdir -p admin
+ln -s ../node_modules/@anydigital/11ty-bricks/src/starter/admin/index.html admin/index.html
+```
+
+### Benefits of Symlinking
+
+- **Always up-to-date**: Configuration automatically updates when you upgrade the package
+- **Less maintenance**: No need to manually sync configuration changes
+- **Quick setup**: Get started immediately with best-practice configurations
+- **Easy customization**: Override specific settings by creating your own config that imports from the symlinked version
+
+### Alternative: Copy Files
+
+If you prefer to customize the configurations extensively, you can copy the files instead:
+
+```bash
+cp node_modules/@anydigital/11ty-bricks/src/starter/eleventy.config.js .
+cp node_modules/@anydigital/11ty-bricks/src/starter/tailwind.config.js .
+mkdir -p admin
+cp node_modules/@anydigital/11ty-bricks/src/starter/admin/index.html admin/
+```
+
 ## CLI Helper Commands
 
 After installing this package, the `download-files` command becomes available:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anydigital/11ty-bricks",
-  "version": "1.0.0-alpha.10",
+  "version": "1.0.0-alpha.12",
   "description": "A collection of helpful utilities and filters for Eleventy (11ty)",
   "type": "module",
   "main": "./src/index.js",
@@ -46,6 +46,6 @@
     "node": ">=18.0.0"
   },
   "_downloadFiles": {
-    "https://raw.githubusercontent.com/danurbanowicz/eleventy-sveltia-cms-starter/refs/heads/master/admin/index.html": "src/sveltia-admin/index.html"
+    "https://raw.githubusercontent.com/danurbanowicz/eleventy-sveltia-cms-starter/refs/heads/master/admin/index.html": "src/starter/admin/index.html"
   }
 }

package/src/index.js

@@ -19,7 +19,7 @@ import { siteData } from "./siteData.js";
  * @param {boolean} options.fragments - Enable fragment shortcode (default: false)
  * @param {boolean} options.setAttrFilter - Enable setAttr filter (default: false)
  * @param {boolean} options.byAttrFilter - Enable byAttr filter (default: false)
- * @param {boolean} options.siteData - Enable site.year global data (default: false)
+ * @param {boolean} options.siteData - Enable site.year and site.isProd global data (default: false)
  */
 export default function eleventyBricksPlugin(eleventyConfig, options = {}) {
   const plugins = { bricks, mdAutoRawTags, mdAutoNl2br, fragments, setAttrFilter, byAttrFilter, siteData };

package/src/starter/eleventy.config.js

@@ -0,0 +1,67 @@
+/* CLI */
+import minimist from "minimist";
+/* Plugins */
+import { RenderPlugin } from "@11ty/eleventy";
+import eleventyNavigationPlugin from "@11ty/eleventy-navigation";
+import eleventyBricksPlugin from "@anydigital/11ty-bricks";
+/* Libraries */
+import markdownIt from "markdown-it";
+import markdownItAnchor from "markdown-it-anchor";
+/* Data */
+import yaml from "js-yaml";
+
+/**
+ * Eleventy Configuration
+ * @param {Object} eleventyConfig - The Eleventy configuration object
+ * @returns {Object} The Eleventy configuration object
+ */
+export default function(eleventyConfig) {
+  /* CLI support */
+  const argv = minimist(process.argv.slice(2));
+  const inputDir = argv.input || "src";
+
+  /* Plugins */
+  eleventyConfig.addPlugin(RenderPlugin);
+  eleventyConfig.addPlugin(eleventyNavigationPlugin);
+  eleventyConfig.addPlugin(eleventyBricksPlugin, {
+    bricks: true,
+    fragments: true,
+    mdAutoNl2br: true,
+    mdAutoRawTags: true,
+    setAttrFilter: true,
+    byAttrFilter: true,
+    siteData: true
+  });
+
+  /* Libraries */
+  eleventyConfig.setLibrary("md", markdownIt({
+    html: true,
+    breaks: true,
+    linkify: true
+  }).use(markdownItAnchor, {
+    permalink: markdownItAnchor.permalink.headerLink()
+  }));
+
+  /* Data */
+  eleventyConfig.addDataExtension("yml", (contents) => yaml.safeLoad(contents));
+
+  /* Build */
+  eleventyConfig.addPassthroughCopy({ 
+    "src/_public": ".",
+    ...(inputDir !== "src" && { [`${inputDir}/_public`]: "." })
+  }, { expand: true }); // This follows/resolves symbolic links
+
+  /* Dev tools */
+  // Follow symlinks in Chokidar used by 11ty to watch files
+  eleventyConfig.setChokidarConfig({ followSymlinks: true });
+
+  /* Config */
+  return {
+    templateFormats: ["md", "njk"],
+    htmlTemplateEngine: "njk",
+    dir: {
+      input: inputDir,
+      includes: "_template"
+    }
+  };
+};

package/src/starter/tailwind.config.js

@@ -0,0 +1,7 @@
+/** @type {import('tailwindcss').Config} */
+export default {
+  content: [
+    './src*/**/*.{njk,md}',
+  ],
+};
+