# @an11ty/starter-minimal

> Absolutely minimal starter site for an11ty with a few example files.

Latest version **1.0.0** (published 2020-10-02) · VOL license · 0 weekly downloads

## Install

```sh
npm install @an11ty/starter-minimal
pnpm add @an11ty/starter-minimal
yarn add @an11ty/starter-minimal
bun add @an11ty/starter-minimal
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-10-02 |
| First published | 2020-10-02 |
| Weekly downloads | 0 |
| License | VOL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | saibotsivad |
| Maintainers | saibotsivad |
| Keywords | an11ty, 11ty, eleventy, static-site-generator |

## Links

- npm: https://www.npmjs.com/package/@an11ty/starter-minimal
- Repository: https://github.com/an11ty/starter-minimal
- Homepage: https://an11ty.com
- Issues: https://github.com/an11ty/an11ty
- npm.io page: https://npm.io/package/@an11ty/starter-minimal

## Dependencies (2)

- [an11ty](https://npm.io/package/an11ty.md) ^0.0.27
- [@an11ty/template-minimal](https://npm.io/package/@an11ty/template-minimal.md) ^1.0.0

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-10-02
- 0.0.6 — 2020-10-02
- 0.0.5 — 2020-10-02
- 0.0.4 — 2020-10-02

## README

# Starter Site

This is an absolutely minimal starter for a website built
using [an11ty](https://github.com/an11ty/an11ty).

For a more complete starter, you should look at the official
[an11ty starter](https://github.com/an11ty/starter) pack.

## Setup

If you are starting from scratch, you can create a copy with
no bindings to this git repository using:

```bash
npx degit an11ty/starter-minimal my-website
cd my-website
git init
npm install
```

## Build

Build all pages and assets using:

```bash
npm run build
```

## Develop

Same as building, but updates pages and assets when file changes are detected,
and launches a [local HTTP server on port `8080`](http://localhost:8080):

```bash
npm run dev
```

## Folder Structure

This website uses the
[an11ty/template-minimal](https://github.com/an11ty/template-minimal),
which does not have very many options.

### `/`

The root folder of this project will not be built, so it typically
contains documentation or other non-public assets.

### `/site`

This folder contains all the site pages, articles, images, styles, etc.

Although not everything in it will be copied or merged into the final
site, it is safest to consider everything in it as "public" since it
may accidentally be copied over and accessible from your published website.

### `/site/_data`

This folder holds data that is then accessible inside templates. It has
a file [metadata.js](./site/_data/metadata.js) that has the site name and
other significant details.

## Contributing

Please file any issues or start discussions for this starter project
over in the [an11ty issues](https://github.com/an11ty/an11ty).

## License

This starter project published and released under the
[Very Open License](http://veryopenlicense.com), which
is a type of "public domain" license. Attribution is
always appreciated, but it means you are free to remove
this license and any reference to this project, for example
in a business or personal website.

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