Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bchiang7/eleventy-base
https://github.com/bchiang7/eleventy-base
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bchiang7/eleventy-base
- Owner: bchiang7
- Created: 2020-04-25T21:48:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-09T22:57:32.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T13:32:21.020Z (29 days ago)
- Language: SCSS
- Homepage: https://11ty-base.netlify.app/
- Size: 2.51 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Eleventy Base
An [Eleventy](https://github.com/11ty/eleventy) starter based on [Eleventy Base Blog](https://github.com/11ty/eleventy-base-blog) adding Sass, custom webfonts, and JavaScript bundling with Parcel.
## Getting Started
1. Install dependencies
```shell
npm install
```
2. Build and host locally for local development (with hot-reload)
```shell
npm start
```
Or in debug mode:
```shell
npm run debug
```
Or build the site into `_site`:
```shell
npm run build
```
### 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.