Initial commit

lexoyo · web-flow · commit c636fabddbc8 · 2022-11-10T08:25:13.000+01:00
diff --git a/.eleventy.js b/.eleventy.js
@@ -0,0 +1,20 @@
+// Example use for the demo plugin:
+// {{ 'Steph' | hello | safe }}
+
+module.exports = (eleventyConfig, options) => {
+  // Define defaults for your plugin config
+  const defaults = {
+    htmlTag: "h2",
+  };
+
+  // You can create more than filters as a plugin, but here's an example
+  eleventyConfig.addFilter("hello", (name) => {
+    // Combine defaults with user defined options
+    const { htmlTag } = {
+      ...defaults,
+      ...options,
+    };
+
+    return `<${htmlTag}>Hello, ${name}!</${htmlTag}>`;
+  });
+};
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+_site
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+index.md
+_includes
+_site
diff --git a/README.md b/README.md
@@ -0,0 +1,73 @@
+## Eleventy Plugin Template
+
+> A starter environment for creating plugins for Eleventy (11ty).
+
+Fork this repo, or select "Use this template" to get started.
+
+### Using this template
+
+This template is setup to run a single page 11ty site for testing your plugin functionality. The build files are excluded from the final plugin package via `.npmignore`.
+
+Your plugin functionality should live in/be exported from `.eleventy.js`. You will find a sample of creating a filter plugin in this template, including setting up a default config and merging user options.
+
+**Be sure to update the `package.json` with your own details!**
+
+### Testing your plugin
+
+You can test your functionality within this project's local 11ty build by running `npm start`, but you'll also want to test it _as a plugin_.
+
+From another local 11ty project, you can set the `require()` path relatively to your plugin's project directory, and then use it just as you would for a plugin coming from a package.
+
+Example, assuming you place all your repositories within the same parent directory:
+
+```js
+const pluginName = require("../plugin-directory");
+
+module.exports = (eleventyConfig) => {
+  eleventyConfig.addPlugin(pluginName, { optionName: 'if needed' );
+};
+```
+
+Then, run the project to test the plugin's functionality.
+
+Note that making changes in the plugin source will likely require restarting the test project.
+
+### Resources for creating an 11ty plugin
+
+- Bryan Robinson's ["Create a Plugin with 11ty"](https://www.youtube.com/watch?v=aO-NFFKjnnE) demonstration on "Learn With Jason"
+
+---
+
+**The following is a boilerplate for your final plugin README**.
+
+## Usage
+
+Describe how to install your plugin, such as:
+
+```bash
+npm install @scope/plugin-name
+```
+
+Then, include it in your `.eleventy.js` config file:
+
+```js
+const pluginName = require("@scope/plugin-name");
+
+module.exports = (eleventyConfig) => {
+  eleventyConfig.addPlugin(pluginName);
+};
+```
+
+## Config Options
+
+| Option      | Type | Default       |
+| ----------- | ---- | ------------- |
+| option name | type | default value |
+
+## Config Examples
+
+Show examples of likely configurations.
+
+## Credits
+
+Add credits if needed.
diff --git a/_includes/base.njk b/_includes/base.njk
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Plugin Test Page</title>
+</head>
+<body>
+  {{ content | safe }}
+</body>
+</html>
diff --git a/index.md b/index.md
@@ -0,0 +1,34 @@
+---
+layout: base.njk
+---
+
+## Plugin Test Page
+
+Cupcake ipsum dolor. Sit amet I love I love I love. I love pudding dragée. Halvah macaroon halvah I love jujubes bonbon I love pie. Bonbon gingerbread bonbon I love. Tootsie roll chocolate sweet jelly-o lemon drops cotton candy gummies.
+
+Marshmallow macaroon cupcake I love I love jelly beans pudding pastry pie. Macaroon marzipan dragée cake marshmallow I love wafer oat cake. Cake marshmallow muffin cupcake danish. Chocolate cake croissant tiramisu lollipop jelly lollipop cookie caramels cookie. Fruitcake soufflé bonbon cupcake gingerbread I love jelly beans ice cream bonbon. Sugar plum marshmallow marshmallow cake apple pie marzipan sweet tootsie roll croissant.
+
+```js
+module.exports = function (eleventyConfig) {
+  return {
+    dir: {
+      input: "src",
+      output: "public",
+    },
+  };
+};
+```
+
+Gummi bears chocolate bar gummi bears gummies. Soufflé soufflé dessert wafer carrot cake. Bonbon sesame snaps danish soufflé topping danish. Tart danish tootsie roll candy canes cotton candy lemon drops toffee fruitcake. Toffee gummies icing jelly beans toffee halvah. Caramels oat cake cookie topping caramels. Sesame snaps chocolate jujubes pie cake. Brownie chocolate sweet roll jelly-o. Apple pie I love jelly cake cake dragée danish candy. Tart caramels gummi bears bear claw sweet roll marzipan sweet marzipan pie.
+
+Gummi bears candy cotton candy oat cake candy canes bonbon cake. Gummi bears jelly marzipan. Dessert topping biscuit jujubes jelly beans caramels cookie. Gingerbread candy gummi bears I love topping cookie halvah carrot cake topping. Sugar plum tart liquorice liquorice candy pudding powder. I love I love halvah chocolate cake I love cake apple pie wafer.
+
+![test image](http://placecorgi.com/800/200)
+
+I love lollipop chocolate cake marshmallow sesame snaps. Tart gingerbread fruitcake icing sesame snaps danish sesame snaps soufflé jujubes. Halvah I love I love lemon drops. Donut I love candy canes I love dragée sugar plum. I love tootsie roll I love cake. Cupcake danish danish macaroon lemon drops liquorice chocolate tart.
+
+Sugar plum jelly sesame snaps I love powder. Chocolate sesame snaps cake. Pastry brownie donut I love liquorice tootsie roll. Gummi bears sesame snaps I love cookie tootsie roll. I love lemon drops topping toffee cake I love chocolate bar. Biscuit candy sweet candy canes danish danish cake. Marzipan tiramisu sweet roll fruitcake. Jujubes I love candy canes.
+
+Chocolate bar pudding ice cream. Jelly-o tootsie roll pie gingerbread candy jelly beans cupcake donut lollipop. Croissant topping cake apple pie gummi bears gingerbread donut croissant tiramisu. Gummies chupa chups donut caramels gummies cotton candy cookie muffin pudding. Chocolate cake dessert bonbon I love. Marzipan jujubes jelly beans. I love wafer cookie carrot cake caramels sesame snaps cotton candy marshmallow.
+
+Gummies toffee I love danish I love macaroon sesame snaps cookie. Macaroon lollipop apple pie powder marzipan bonbon brownie sweet roll I love. Gummi bears ice cream pie oat cake cupcake wafer sesame snaps. Sweet brownie icing. Tart sweet sugar plum danish cupcake I love. Fruitcake tart sweet roll soufflé. Muffin ice cream I love I love sugar plum jujubes carrot cake wafer I love. Icing brownie cake I love sugar plum I love cake.
diff --git a/package.json b/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "@scope/plugin-name",
+  "version": "1.0.0",
+  "description": "Description of plugin",
+  "homepage": "",
+  "main": ".eleventy.js",
+  "scripts": {
+    "start": "eleventy --serve",
+    "build": "eleventy",
+    "bump": "npm --no-git-tag-version version"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/username/repo-name.git"
+  },
+  "keywords": [
+    "11ty",
+    "11ty-plugin",
+    "eleventy",
+    "eleventy-plugin"
+  ],
+  "author": {
+    "name": "username",
+    "url": "https://website.com"
+  },
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/username/repo-name/issues"
+  },
+  "devDependencies": {
+    "@11ty/eleventy": "^0.11.1"
+  }
+}
