Complete conversion into 11ty

Author: trevorsaint

.editorconfig

@@ -5,5 +5,5 @@ root = true
 charset = utf-8
 indent_size = 2
 indent_style = space
-insert_final_newline = false
-trim_trailing_whitespace = false
+insert_final_newline = true
+trim_trailing_whitespace = false

.eleventy.js

@@ -0,0 +1,101 @@
+/*
+USEFUL LINKS:
+
+https://github.com/11ty/eleventy/issues/812
+https://www.npmjs.com/package/@thedigitalman/eleventy-plugin-toc-a11y
+https://www.trysmudford.com/blog/encapsulated-11ty-components
+https://www.brycewray.com/posts/2022/09/shorter-shortcuts-nunjucks-macros-eleventy
+https://davidea.st/articles/11ty-tips-i-wish-i-knew-from-the-start
+https://dev.to/murtuzaalisurti/adding-custom-anchors-to-headings-in-markdown-eleventy-275o
+*/
+
+const markdownIt = require('markdown-it');
+const markdownItAttrs = require('markdown-it-attrs');
+const markdownItAnchor = require('markdown-it-anchor');
+
+
+// Breadcrumb trail
+const eleventyNavigationPlugin = require('@11ty/eleventy-navigation');
+
+
+// Table of contents
+const eleventyPluginTOC = require('@thedigitalman/eleventy-plugin-toc-a11y');
+
+
+const markdownItOptions = {
+  html: true,
+  breaks: true,
+  linkify: false
+};
+
+
+const markdownItAnchorOptions = {
+  level: 2,
+  tabIndex: false
+};
+
+
+module.exports = function (eleventyConfig) {
+
+
+  eleventyConfig.setUseGitIgnore(false);
+
+
+  // Copy GOV.UK fonts
+  eleventyConfig.addPassthroughCopy({'node_modules/govuk-frontend/govuk/assets/fonts': 'assets/fonts'});
+
+
+  // Copy MOD.UK assets
+  eleventyConfig.addPassthroughCopy({'./src/assets/images': 'assets/images'});
+
+
+  // Table of contents
+  eleventyConfig.addPlugin(eleventyPluginTOC, {
+    tags: ['h2'],
+    wrapper: 'nav',
+    wrapperClass: 'gem-c-contents-list',
+    heading: true,
+    headingClass: 'gem-c-contents-list__title',
+    headingLevel: 'h2',
+    headingText: 'Contents',
+    listType: 'ol',
+    listClass: 'gem-c-contents-list__list',
+    listItemClass: 'gem-c-contents-list__list-item gem-c-contents-list__list-item--dashed',
+    listItemAnchorClass: 'gem-c-contents-list__link govuk-link govuk-link--no-visited-state',
+  });
+
+
+  // Macros used in markdown files
+  eleventyConfig.addCollection('everything', (collectionApi) => {
+    const macroImport = `{%- from 'system/component.njk' import component -%}{%- from 'system/modukcomponent.njk' import modukcomponent -%}`
+    let collMacros = collectionApi.getFilteredByGlob('src/**/*.md')
+    collMacros.forEach((item) => {
+      item.template.frontMatter.content = `${macroImport}\n${item.template.frontMatter.content}`
+    })
+    return collMacros
+  });
+
+
+  // Markdown configurations
+  eleventyConfig.setLibrary('md', markdownIt(markdownItOptions).use(markdownItAnchor, markdownItAnchorOptions).use(markdownItAttrs));
+
+
+  // Navigation
+  eleventyConfig.addPlugin(eleventyNavigationPlugin);
+
+
+  // Configurations
+  return {
+    dir: {
+      input: 'src',
+      output: 'public',
+      includes: '_includes'
+    },
+    templateFormats: [ 'md', 'njk', 'html'],
+    markdownTemplateEngine: 'njk',
+    htmlTemplateEngine: 'njk',
+    dataTemplateEngine: 'njk',
+  };
+
+
+};

.github/workflows/build-and-deploy.yml

@@ -0,0 +1,21 @@
+name: Build and Deploy
+on: [push]
+permissions:
+  contents: write
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+
+      - name: Install and Build
+        run: |
+          npm ci
+          npm run prod
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: public
+          clean: true

.gitignore

@@ -14,7 +14,6 @@ logs
 # Other
 .env
 .npm
-package-lock.json
 npm-debug.log
 *.cache
-.vscode
+.vscode

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

Procfile

@@ -31,12 +31,12 @@ Watch for changes to `CSS`, `JS`, `Images`, `Nunjucks`. Automatically update the
 npm run dev
 ```
 
-Visit: <a href="http://localhost:3000">http://localhost:3000</a>
+Visit: <a href="http://localhost:8080">http://localhost:8080</a>
 
 ## Build app for production
 
 Render `CSS`, `JS`, `Images`, `Nunjucks`. Compress files and generates `HTML` pages, ready for production. It also performs a [W3C validation](https://validator.w3.org) on `HTML`, to ensure everything is valid.
 
 ```
 npm run prod
-```
+```