feat: use fernfolio theme

Author: sylvainmetayer

.eleventy.js

@@ -1,101 +1,120 @@
-const rssPlugin = require('@11ty/eleventy-plugin-rss');
-const syntaxHighlight = require('@11ty/eleventy-plugin-syntaxhighlight');
-const fs = require('fs');
-
-const pluginTOC = require('eleventy-plugin-toc')
-
-
-const filters = require('./src/11ty/filters');
-const filtersMethods = Object.entries(filters);
-
-// Import transforms
-const parseTransform = require('./src/11ty/transforms/parse-transform.js');
-
-const markdownConfig = require('./src/11ty/utils/markdown.js');
-
-// Import data files
-const site = require('./src/_data/site.json');
-
-const passthroughItems = [
-  "src/_redirects",
-  "src/fonts",
-  "src/images",
-  "src/js",
-  "src/css",
-  "src/uploads",
-  "node_modules/nunjucks/browser/nunjucks-slim.js"
-]
-
-module.exports = function (config) {
-  // Filters
-  filtersMethods.forEach(([name, filter]) => {
-    config.addFilter(name, filter)
+const { DateTime } = require("luxon");
+const CleanCSS = require("clean-css");
+const UglifyJS = require("uglify-es");
+const htmlmin = require("html-minifier");
+const eleventyNavigationPlugin = require("@11ty/eleventy-navigation");
+const slugify = require('slugify');
+
+module.exports = function(eleventyConfig) {
+
+  // Eleventy Navigation https://www.11ty.dev/docs/plugins/navigation/
+  eleventyConfig.addPlugin(eleventyNavigationPlugin);
+
+  // Configuration API: use eleventyConfig.addLayoutAlias(from, to) to add
+  // layout aliases! Say you have a bunch of existing content using
+  // layout: post. If you don’t want to rewrite all of those values, just map
+  // post to a new file like this:
+  // eleventyConfig.addLayoutAlias("post", "layouts/my_new_post_layout.njk");
+
+  // Merge data instead of overriding
+  // https://www.11ty.dev/docs/data-deep-merge/
+  eleventyConfig.setDataDeepMerge(true);
+
+  // Add support for maintenance-free post authors
+  // Adds an authors collection using the author key in our post frontmatter
+  // Thanks to @pdehaan: https://github.com/pdehaan
+  eleventyConfig.addCollection("authors", collection => {
+    const blogs = collection.getFilteredByGlob("src/posts/*.md");
+    return blogs.reduce((coll, post) => {
+      const author = slugify(post.data.author);
+      if (!author) {
+        return coll;
+      }
+      if (!coll.hasOwnProperty(author)) {
+        coll[author] = [];
+      }
+      coll[author].push(post.data);
+      return coll;
+    }, {});
   });
 
-  // Transforms
-  config.addTransform('parse', parseTransform);
-
-  passthroughItems.forEach(item => {
-    config.addPassthroughCopy(item);
-  })
+  // Date formatting (human readable)
+  eleventyConfig.addFilter("readableDate", dateObj => {
+    return DateTime.fromJSDate(dateObj).toFormat("dd/MM/yyyy");
+  });
 
-  config.addCollection('posts', collection => {
-    return [
-      ...collection.getFilteredByGlob('./src/posts/*.md')
-    ].reverse();
+  // Date formatting (machine readable)
+  eleventyConfig.addFilter("machineDate", dateObj => {
+    return DateTime.fromJSDate(dateObj).toFormat("yyyy-MM-dd");
   });
 
-  config.addCollection('work', collection => {
-    return collection.getFilteredByGlob('./src/work/*.md')
-      .sort((a, b) => b.data.start - a.data.start);
+  // Minify CSS
+  eleventyConfig.addFilter("cssmin", function(code) {
+    return new CleanCSS({}).minify(code).styles;
   });
 
-  // Plugins
-  config.addPlugin(rssPlugin);
-  config.addPlugin(syntaxHighlight);
-  config.addPlugin(pluginTOC, {
-    tags: ['h2', 'h3', 'h4'],
-    wrapper: 'nav',
-    wrapperClass: 'toc'
+  // Minify JS
+  eleventyConfig.addFilter("jsmin", function(code) {
+    let minified = UglifyJS.minify(code);
+    if (minified.error) {
+      console.log("UglifyJS error: ", minified.error);
+      return code;
+    }
+    return minified.code;
   });
 
-  // 404
-  config.setBrowserSyncConfig({
-    ui: false,
-    // Replicate click on all opened tabs
-    ghostMode: false,
-    callbacks: {
-      ready: function (err, browserSync) {
-        const content_404 = fs.readFileSync('dist/404.html');
-
-        browserSync.addMiddleware('*', (req, res) => {
-          // Provides the 404 content without redirect.
-          res.write(content_404);
-          res.end();
-        });
-      }
+  // Minify HTML output
+  eleventyConfig.addTransform("htmlmin", function(content, outputPath) {
+    if (outputPath && outputPath.indexOf(".html") > -1) {
+      let minified = htmlmin.minify(content, {
+        useShortDoctype: true,
+        removeComments: true,
+        collapseWhitespace: true
+      });
+      return minified;
     }
+    return content;
   });
 
-  config.setLibrary("md", markdownConfig)
+  // Don't process folders with static assets e.g. images
+  eleventyConfig.addPassthroughCopy("src/favicon.ico");
+  eleventyConfig.addPassthroughCopy("src/static/img");
+  eleventyConfig.addPassthroughCopy("src/admin");
+  eleventyConfig.addPassthroughCopy("src/_includes/assets/");
+
+  /* Markdown Plugins */
+  let markdownIt = require("markdown-it");
+  let markdownItAnchor = require("markdown-it-anchor");
+  let options = {
+    html: true,
+    breaks: true,
+    linkify: true
+  };
+  let opts = {
+    permalink: false
+  };
 
-  config.setFrontMatterParsingOptions({
-    excerpt: true,
-    excerpt_separator: "---"
-  });
+  eleventyConfig.setLibrary("md", markdownIt(options)
+    .use(markdownItAnchor, opts)
+  );
 
   return {
-    templateFormats: [
-      "md",
-      "njk",
-    ],
-    markdownTemplateEngine: "njk",
+    templateFormats: ["md", "njk", "html", "liquid"],
+
+    // If your site lives in a different subdirectory, change this.
+    // Leading or trailing slashes are all normalized away, so don’t worry about it.
+    // If you don’t have a subdirectory, use "" or "/" (they do the same thing)
+    // This is only used for URLs (it does not affect your file structure)
+    pathPrefix: "/",
+
+    markdownTemplateEngine: "liquid",
     htmlTemplateEngine: "njk",
     dataTemplateEngine: "njk",
     dir: {
-      input: 'src',
-      output: 'dist'
-    },
-    passthroughFileCopy: true
+      input: "src",
+      includes: "_includes",
+      data: "_data",
+      output: "dist"
+    }
   };
 };

.eleventyignore

@@ -0,0 +1,2 @@
+README.md
+.github/

.gitignore

@@ -1,17 +1,3 @@
-*.log
-npm-debug.*
-*.scssc
-*.log
-*.swp
-.DS_Store
-.sass-cache
-node_modules
-dist 
-
-# Specifics
-
-# Hide design tokens
-src/scss/_tokens.scss
-
-# Hide compiled CSS
-src/_includes/assets/*
+_site/
+node_modules/
+package-lock.json

.nvmrc

@@ -0,0 +1 @@
+10

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Sylvain METAYER
+Copyright (c) 2021 Tyler M. Roderick
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,19 +1,79 @@
-# Personal Website
+[![Netlify Status](https://api.netlify.com/api/v1/badges/5702ba89-7242-490e-b04d-e4a691faced5/deploy-status)](https://app.netlify.com/sites/fernfolio/deploys)
 
-[![Depfu](https://badges.depfu.com/badges/7a567e824b66dfa3193846d89c9b8e59/overview.svg)](https://depfu.com/github/sylvainmetayer/site?project_id=14116)
-![Github Eleventy Build](https://github.com/sylvainmetayer/site/workflows/Eleventy%20Build/badge.svg)
-[![Netlify Status](https://api.netlify.com/api/v1/badges/eea326e0-9c5d-443f-a0e5-ba949add331a/deploy-status)](https://app.netlify.com/sites/wizardly-aryabhata-f4e800/deploys)
+# Fernfolio
+The super simple portfolio template built with [Eleventy](https://www.11ty.io/) and [Netlify CMS](https://www.netlifycms.org/)
 
-> Sylvain METAYER
->
-> Inspired from [Hylia theme](https://github.com/hankchizljaw/hylia) and others
+<img width="1280" alt="fernfolio screenshot" src="https://raw.githubusercontent.com/TylerMRoderick/fernfolio-11ty-template/master/fernfolio-preview.png">
 
-## Setup
+### <pre>🖥  [Demo](https://fernfolio.netlify.app/)</pre>
 
-- `npm ci`
+## 🤔 What is this?
+An [Eleventy](https://www.11ty.io/) theme designed to simplify the process of deploying a beautiful portfolio and blog. Launch your site in minutes!
 
-- `npm start`
+Based on the [eleventy-netlify-boilerplate](https://github.com/danurbanowicz/eleventy-netlify-boilerplate), but modified to perfectly fit the needs of a modern technical porfolio.
 
-## Build
+## ✨ Features
+* Built in support for [Netlify CMS](https://www.netlifycms.org/) with editor previews
+* Customizable blog and project pages with tag support
+* Working contact form powered by [Netlify Forms](https://www.netlify.com/products/forms/)
+* Super fast page render and high lighthouse scores
+* Uses Markdown for content files and Nunjucks for layouts
+* 100% Javascript framework free
+* Continuous Deployment workflow via [Netlify](https://www.netlify.com/)
+* Base styles powered by [Sakura](https://github.com/oxalorg/sakura) classless css framework
+* Vanilla css for custom styles (keep it simple)
 
-- `npm run build`
+
+## 🚀 Quick Start
+
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/TylerMRoderick/fernfolio-11ty-template&stack=cms)
+
+### 1. Click the "Deploy to Netlify" button above
+This will clone this repo to your github account and will deploy a copy of the demo website to your Netlify
+account (you can create an account during this process if you don't have one)
+
+### 2. Setup authentication
+
+After deploying this project, Netlify Identity will add you as a CMS user and
+will email you an invite. Hit the "Accept the invite" link and this should take you to the deployed site. From there, you can add your password to finish user setup.
+
+### 3. Edit some content
+Now that you are added as a CMS user, add `/admin` to the end of your site url, and log in using your new credentials. You should now see the content editor interface. Now you can start editing content! Any changes to your new repo will auto-deploy a new version to netflify. Cool huh?
+
+### 4. Setup local environment
+- Clone the repo locally `git clone https://github.com/TylerMRoderick/fernfolio-11ty-template.git`
+- Navigate to root folder `cd your-site`
+- Install the goods `npm install`
+- Run it `npm start`
+- You should now be able to see everything running on localhost:8080
+- Add some changes (view [theme customizations](https://fernfolio.netlify.app/posts/theme-customizations/) for some options) 
+- Push your changes to github and an auto-deploy should be triggered
+
+## 💻 Development Scripts
+
+**`npm start`**
+
+> Run 11ty with hot reload at localhost:8080
+
+**`npm run build`**
+
+> Generate minified production build
+
+Use this as the "Publish command" if needed by hosting such as Netlify.
+
+Checkout the Eleventy [Command Line Usage docs](https://www.11ty.dev/docs/usage/) for more options 
+
+
+## 🎩 Common issues
+
+If you change the repo that was created at deploy time from public to private, you'll need to regenerate your token,
+as the token generated using the deploy to Netlify button can only access public repositories. To
+regenerate your token, head to "Settings" in your Netlify site dashboard, go to the "Identity"
+section, then scroll to "Services" where you'll see an "Edit settings" button. Click that and you'll
+see a text link to "Generate access token in GitHub".
+
+If you need any help with setting up Netlify CMS, you can reach out to the Netlify team in the [Netlify CMS Gitter](https://gitter.im/netlify/netlifycms).
+
+## Bug reports, feature requests, etc
+
+This is an ongoing project and I welcome contributions and suggestions! Feel free to submit a PR or issue.