cobweb/xmitter-11ty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
47 Commits 1 Branch 0 Tags 8.3 MiB
XSLT 80.3%
Nunjucks 7.1%
JavaScript 6.6%
CSS 6%
963b5d46e6
Go to file
Zach Leatherman 963b5d46e6 Refactors Liquid syntax highlighters to add line highlights. 
Usage (ranges are space separated):

{% highlight js 1,4-6 %}
One range
Adds `highlight-line-active` to lines 1,4,5,6

{% highlight js 3-4 -1 %}
Two ranges (add/remove), remove is N/A
Adds `highlight-line-add` to lines 3,4

{% highlight js -1 3-4 %}
Two ranges (add/remove), add is N/A
Adds `highlight-line-remove` to lines 3,4

{% highlight js 3-4 5,8-10 %}
Two ranges, both are used
Adds `highlight-line-add` to lines 3-4
Adds `highlight-line-remove` to lines 5,8,9,10
2018-01-26 22:12:46 -06:00
_data Move from atom.xml to feed.xml for tech agnostic-ish filename. 2018-01-25 21:02:35 -06:00
_includes Emoji was bad. 2018-01-26 21:33:07 -06:00
_src Refactors Liquid syntax highlighters to add line highlights. 2018-01-26 22:12:46 -06:00
about start of eleventy-base-blog that pairs with 0.2.8 2018-01-22 08:17:48 -06:00
css Refactors Liquid syntax highlighters to add line highlights. 2018-01-26 22:12:46 -06:00
feed Move from atom.xml to feed.xml for tech agnostic-ish filename. 2018-01-25 21:02:35 -06:00
posts Adds a syntax highlighter example to templates for #3 2018-01-22 23:12:08 -06:00
.eleventy.js Refactors Liquid syntax highlighters to add line highlights. 2018-01-26 22:12:46 -06:00
.eleventyignore Initial commit. 2018-01-16 21:08:47 -06:00
.gitignore Initial commit. 2018-01-16 21:08:47 -06:00
.nvmrc Adds an .nvmrc for netlify deploys. 2018-01-25 14:21:01 -06:00
.travis.yml Change default config to use pathPrefix: "/" and then use --pathprefix="/eleventy-base-blog/ for GitHub deploy command. Requires Eleventy v0.2.11 2018-01-25 21:03:57 -06:00
index.njk Moves warning message to _includes/base.njk, adds a home link to posts 2018-01-25 23:36:31 -06:00
LICENSE Initial commit 2018-01-15 13:28:08 -06:00
netlify.toml Netlify defaults. 2018-01-25 21:12:48 -06:00
package.json v3.0.0 2018-01-25 21:04:47 -06:00
README.md Adds Netlify stuff to the readme. 2018-01-25 21:34:34 -06:00

README.md

eleventy-base-blog

A starter repository showing how to build a blog with the Eleventy static site generator.

Build Status

Demos

Getting Started

1. Clone this repository:

git clone https://github.com/11ty/eleventy-base-blog.git my-blog-name

2. Navigate to the directory

cd my-blog-name

Specifically have a look at .eleventy.js to see if you want to configure any Eleventy options differently.

3. Install dependencies

npm install

4. Edit _data/metadata.json

5. Run Eleventy

npx eleventy

Or build automatically when a template changes:

npx eleventy --watch

Or in debug mode:

DEBUG=* npx eleventy

Implementation Notes

  • about/index.md shows how to add a content page.
  • posts/ has the blog posts but really they can live in any directory. They need only the post tag to be added to this collection.
  • Add the nav tag to add a template to the top level site navigation. For example, this is in use on index.njk and about/index.md.
  • Content can be any template format (blog posts needn’t be markdown, for example). Configure your supported templates in .eleventy.js -> templateFormats.
    • Because css and png are listed in templateFormats but are not supported template types, any files with these extensions will be copied without modification to the output (while keeping the same directory structure).
  • The blog post feed template is in feed/feed.njk. This is also a good example of using a global data files in that it uses _data/metadata.json.
  • This example uses three layouts:
    • _includes/layouts/base.njk: the top level HTML structure
    • _includes/layouts/home.njk: the home page template (wrapped into base.njk)
    • _includes/layouts/post.njk: the blog post template (wrapped into base.njk)
  • _includes/postlist.njk is a Nunjucks include and is a reusable component used to display a list of all the posts. index.njk has an example of how to use it.