Skip to content

Commit

Permalink
Readme update (netlify-templates#3)
Browse files Browse the repository at this point in the history
* updated README.md, added eleventy-blog-starter.jpg
  • Loading branch information
TomasBankauskas authored Dec 10, 2024
1 parent 45605ce commit be9ea35
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# Eleventy (11ty) blog starter
# Eleventy (11ty) Blog Starter

![Eleventy Blog Starter preview.](eleventy-blog-starter.jpg)

A starter repository showing how to build a blog with the [Eleventy](https://www.11ty.dev/) and [Tailwind CSS](https://tailwindcss.com/).

**View demo:** [https://eleventy-blog-starter-demo.netlify.app/](https://eleventy-blog-starter-demo.netlify.app/)

## Deploying to Netlify

If you click "Deploy to Netlify" button, it will create a new repo for you that looks exactly like this one, and sets that repo up immediately for deployment on Netlify.

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/eleventy-blog-starter)


## Getting started
## Getting Started

1. Clone this Repository

Expand Down Expand Up @@ -37,7 +41,7 @@ npm run build

Or you can run [debug mode](https://www.11ty.dev/docs/debugging/) to see all the internals.

## Project structure
## Project Structure

- `content/blog/` has the blog posts but really they can live in any directory. They need only the `posts` tag to be included in the blog posts [collection](https://www.11ty.dev/docs/collections/).
- Use the `eleventyNavigation` key (via the [Eleventy Navigation plugin](https://www.11ty.dev/docs/plugins/navigation/)) in your front matter to add a template to the top level site navigation. This is in use on `content/index.njk` and `content/about/index.md`.
Expand Down
Binary file added eleventy-blog-starter.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit be9ea35

Please sign in to comment.