Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lkhrs/eleventy-simple
A blog starter template with 11ty and Simple.css.
https://github.com/lkhrs/eleventy-simple
eleventy simplecss
Last synced: about 1 month ago
JSON representation
A blog starter template with 11ty and Simple.css.
- Host: GitHub
- URL: https://github.com/lkhrs/eleventy-simple
- Owner: lkhrs
- License: mit
- Created: 2022-08-12T22:18:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T21:47:59.000Z (2 months ago)
- Last Synced: 2024-09-13T11:21:14.126Z (2 months ago)
- Topics: eleventy, simplecss
- Language: Nunjucks
- Homepage: https://eleventy-simple.pages.dev
- Size: 509 KB
- Stars: 28
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eleventy-simple
A blog starter using [11ty](https://github.com/11ty/eleventy) and [Simple.css](https://github.com/kevquirk/simple.css). Based on [eleventy-base-blog](https://github.com/11ty/eleventy-base-blog)
## Demo
[eleventy-simple.pages.dev](https://eleventy-simple.pages.dev)
## Getting Started
### 1. Clone this Repository
```
git clone https://github.com/lkhrs/eleventy-simple.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 @11ty/eleventy
```
Or build and host locally for local development
```
npx @11ty/eleventy --serve
```
Or build automatically when a template changes:
```
npx @11ty/eleventy --watch
```
Or in debug mode:
```
DEBUG=* npx @11ty/eleventy
```
## Documentation
- [Eleventy](https://www.11ty.dev/docs/)
- [Simple.css](https://github.com/kevquirk/simple.css/wiki)
### 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.
- Use the `eleventyNavigation` key in your front matter 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`.
- The `css` and `img` directories in the input directory will be copied to the output folder (via `addPassthroughCopy()` in the `.eleventy.js` file).
- 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.