This is a template repo for the eleventy (11ty) jamstack.
Overview:
Jace-ty is an opinionated template for 11ty, a static site generator. It provides a folder structure for each post with proper passthrough for files, easy theme switching, RSS functionality, syntax highlighting, simple search feature, and comments powered by utteranc.es. The template is designed to be semantic and easy to customize.
Features:
- Syntax Highlighting: Uses PrismJS theme prism-a11y-dark.css with @11ty/eleventy-plugin-syntaxhighlight.
- Simple Search: Allows for title, subtitle, summary, and meta field searches on posts.
- RSS: Includes an Atom 1.0 valid feed from feed.njk.
- Folder Structure for Posts: Each post gets a folder, allowing you to keep your assets relative to your content.
- Comments powered by utteranc.es: If you set up utteranc.es on your repo, you can include comments on posts.
- Theme Files take a Backseat to Local Files: You can customize the theme by creating or modifying files in the src/layouts/ folder. If a file with the same name exists in src/theme/jace-ty/, the layouts file will be used instead.
- Easy Theme Switching: The template allows you to switch themes easily by defining the theme in the site.js file.
Installation:
To install the Jace-ty theme and set it up for deployment on Netlify, follow these steps:
- Clone the git repository of this project.
- Deploy the cloned repository to Netlify using the “Deploy to Netlify” button on the live preview page. Grant permission to add the repository for you.
- Netlify will create a new site for you and configure it to use your repository. You can now deploy changes by pushing code to your repository.
- Update the
site.js file in the src/_data/ folder to customize the details of your site. - Make sure the repository is public on GitHub if you want to use Utteranc.es for comments.
- Customize the theme by creating or modifying files in the
src/layouts/ folder. You can switch back to the default theme by renaming or deleting your custom files.
Summary:
Jace-ty is an opinionated template for 11ty that provides a convenient structure and features to build a static site. It offers syntax highlighting, simple search, RSS functionality, easy theme switching, and comments powered by utteranc.es. The template allows for customization while maintaining a semantic design. To install the theme, clone the repository, deploy it on Netlify, and update the necessary files to customize your site.