# @an11ty/template

> [WIP] Default an11ty site and configuration, with all sorts of goodies.

Latest version **0.0.4** (published 2020-09-30) · VOL license · 0 weekly downloads

## Install

```sh
npm install @an11ty/template
pnpm add @an11ty/template
yarn add @an11ty/template
bun add @an11ty/template
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2020-09-30 |
| First published | 2020-09-19 |
| Weekly downloads | 0 |
| License | VOL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 24 |
| Unpacked size | 6.3 MB |
| Known vulnerabilities | 0 (+4 in 3 direct dependencies) |
| Install scripts | no |
| Author | Tobias Davis |
| Maintainers | saibotsivad |

## Links

- npm: https://www.npmjs.com/package/@an11ty/template
- Repository: https://github.com/an11ty/template
- Homepage: https://github.com/an11ty/template#readme
- Issues: https://github.com/an11ty/template/issues
- npm.io page: https://npm.io/package/@an11ty/template

## Dependencies (24)

- [glob](https://npm.io/package/glob.md) ^7.1.6
- [luxon](https://npm.io/package/luxon.md) ^1.21.3
- [vinyl](https://npm.io/package/vinyl.md) ^2.2.0
- [cssesc](https://npm.io/package/cssesc.md) ^3.0.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [webpack](https://npm.io/package/webpack.md) ^4.44.1
- [clean-css](https://npm.io/package/clean-css.md) ^4.2.3
- [memory-fs](https://npm.io/package/memory-fs.md) ^0.5.0
- [node-sass](https://npm.io/package/node-sass.md) ^4.14.1
- [focus-trap](https://npm.io/package/focus-trap.md) ^5.1.0
- [svg-sprite](https://npm.io/package/svg-sprite.md) ^1.5.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.11.4
- [markdown-it](https://npm.io/package/markdown-it.md) ^8.4.2
- [babel-loader](https://npm.io/package/babel-loader.md) ^8.1.0
- [focus-visible](https://npm.io/package/focus-visible.md) ^5.1.0
- [html-minifier](https://npm.io/package/html-minifier.md) ^4.0.0
- [@11ty/eleventy](https://npm.io/package/@11ty/eleventy.md) ^0.11.0
- [glob-module-file](https://npm.io/package/glob-module-file.md) ^3.0.2
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.11.0
- [markdown-it-anchor](https://npm.io/package/markdown-it-anchor.md) ^5.2.5
- [@11ty/eleventy-navigation](https://npm.io/package/@11ty/eleventy-navigation.md) ^0.1.6
- [@11ty/eleventy-plugin-rss](https://npm.io/package/@11ty/eleventy-plugin-rss.md) ^1.0.9
- [@babel/plugin-transform-runtime](https://npm.io/package/@babel/plugin-transform-runtime.md) ^7.11.0
- [@11ty/eleventy-plugin-syntaxhighlight](https://npm.io/package/@11ty/eleventy-plugin-syntaxhighlight.md) ^3.0.1

## Recent versions

- 0.0.4 (latest) — 2020-09-30
- 0.0.3 — 2020-09-25
- 0.0.2 — 2020-09-19

## README

# An11ty Template

This is the default template recommended by [An11ty](https://www.npmjs.com/package/an11ty).

The behaviour of `an11ty` is to overwrite template files with your files, instead of merging them. That can be a bit of a hassle if you aren't careful, so this default site has a lot of functionality packed in that you can extend it in many ways without needing to overwrite files.

## Extending `.eleventy.js`

Instead of rewriting the `.eleventy.js` configuration file, name your file `.an11ty.js` and it will be run like the normal 11ty configuration file, *after* the base one is run. (If you need it to run before, name it `.an11ty-before.js` instead. Or do both.)

Example of adding a single filter:

```js
// .an11ty.js (in your site's folder)
module.exports = function (eleventyConfig) {
	eleventyConfig.addFilter('uppercase', (string) => {
		return string.toUpperCase();
	});
};
```

If you return a configuration object, for example to change the returned `templateFormats` list, your object will be merged with the default ones using a non-recursive `Object.assign`.

This means to add a new template format, since it's an array, you would need to return the full updated array.

Example of only changing the HTML template engine:

```js
// .an11ty.js (in your site's folder)
module.exports = function () {
	return {
		htmlTemplateEngine: 'pug'
	};
};
```












---

## Roadmap

image resizing stuff? https://github.com/image-size/image-size



---

A starter repository showing how to build a blog with the [Eleventy](https://github.com/11ty/eleventy) static site generator.

[![Build Status](https://travis-ci.org/11ty/eleventy-base-blog.svg?branch=master)](https://travis-ci.org/11ty/eleventy-base-blog)

## Demos

* [Netlify](https://eleventy-base-blog.netlify.com/)
* [GitHub Pages](https://11ty.github.io/eleventy-base-blog/)
* [Remix on Glitch](https://glitch.com/~11ty-eleventy-base-blog)

## Deploy this to your own site

These builders are amazing—try them out to get your own Eleventy site in a few clicks!

* [Get your own Eleventy web site on Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/11ty/eleventy-base-blog)
* [Get your own Eleventy web site on Vercel](https://vercel.com/import/project?template=11ty%2Feleventy-base-blog)

## 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 and host locally for local development
```
npx eleventy --serve
```

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.




## Credits

Highly inspired by https://github.com/hankchizljaw/hylia

---
_Source: https://npm.io/package/@an11ty/template · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._