Browse Source

replace upstream README with project-specific one

Noah Hall 2 years ago
1 changed files with 17 additions and 72 deletions
  1. +17

+ 17
- 72 View File

@ -1,77 +1,22 @@
# eleventy-base-blog
# My site (
My site is based on the [eleventy-base-blog template](
A starter repository showing how to build a blog with the [Eleventy]( static site generator.
The original readme is available on branch "upstream".
[![Build Status](](
Currently, deploy is done by pushing directly to `mybox`.
## Demos
Render with `gulp` or check the list of exports in `gulpfile.js` for individual build steps.
* [Netlify](
* [GitHub Pages](
## 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](
* [Get your own Eleventy web site on Vercel](
## Getting Started
### 1. Clone this Repository
git clone 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/` 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/`.
* 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.
## TODO:
* Specific/soon:
* [ ] more details in README #dff8d1a8
* [ ] edits to Tech Ethics Audit post #629367a9
* [.] change `<li>` list-style-icon (accessibility concern) #f4cdbdd8
* [ ] better text contrast (accessibility concern) #8bc7a881
* General/someday:
* [ ] consider automated deploy via gitea? #0c624b4c
* [ ] post more haha #b883b719
* [ ] december birding trip #329bae85
* [ ] better thumbnail generation via ML thumbnail package? #d6d31777
* [ ] improve webmention support? #b9167578