chrissy-dev / simple-journal

A simple journal/photo log website built on top of Eleventy (11ty).

Home Page:https://simplejournal.netlify.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Simple Journal 🏕️

A simple journal/photo log website built on top of Blazin'/11ty.

Deploy to Netlify


Features

  • This project uses Eleventy as a static site generator
  • Templating is Liquid (can be changed if you want)
  • SCSS compiling with Gulp
  • Compile TailwindCSS
  • PurgeCSS to remove unused CSS (Set up for TailwindCSS by default)
  • Resizes and optimises images using Lepto JS
  • Babel is compile ES6 to ES5
  • A good handful of SEO meta tags set up

How to use

Creating an entry

An entry is simple a page in the log. They are basic markdown files with minimal required meta data.

You can only have one entry per day

All entries live within the ./src/entries folder. You can organise this folder and name the files any way you want, although it's recommended you use some form of dates in your file name to keep track.

To create an entry for "25th Feburary 2021 create file called 2021-02-25.md in ./src/entries/ and copy the following:

---
name: Wild Camping at Loch Ossian # Required 
date: 2021-02-25 # Required

summited: true|false # Optional
munro: true|false # Optional
camping: true|false # Optional
dug: true|false # Optional
---

Body content here, ~you~ can use *markdown*.

Adding images to an entry

Log looks for images stored in ./src/assets/images/entries/** to check for a folder matching the date of your entry.

To add images to the above example create a folder matching the date of your entry in ./src/assets/images/entries/2021-02-25 and add your images.

Note

This is an open sourced version of a personal project, hopefully other find use out of it. Let me know if you use it.

About

A simple journal/photo log website built on top of Eleventy (11ty).

https://simplejournal.netlify.app

License:MIT License


Languages

Language:CSS 86.3%Language:JavaScript 11.4%Language:HTML 2.1%Language:Liquid 0.1%Language:SCSS 0.1%