Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shidhincr/shidhincr.github.com
Shidhin's blog powered by eleventy.js
https://github.com/shidhincr/shidhincr.github.com
eleventy html
Last synced: about 2 months ago
JSON representation
Shidhin's blog powered by eleventy.js
- Host: GitHub
- URL: https://github.com/shidhincr/shidhincr.github.com
- Owner: shidhincr
- License: mit
- Created: 2013-09-05T06:44:00.000Z (over 11 years ago)
- Default Branch: source
- Last Pushed: 2023-03-17T09:36:15.000Z (almost 2 years ago)
- Last Synced: 2024-04-10T07:05:59.986Z (9 months ago)
- Topics: eleventy, html
- Language: Nunjucks
- Homepage: https://www.undefinednull.com
- Size: 14.3 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# eleventy-base-blog
A starter repository showing how to build a blog with the [Eleventy](https://github.com/11ty/eleventy) static site generator.
[](https://travis-ci.org/11ty/eleventy-base-blog)
## Demos
* [Netlify](https://eleventy-base-blog.netlify.com/)
* [Get your own Eleventy web site on Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/11ty/eleventy-base-blog)—seriously, just click OK a few times and it’s live—Netlify is amazing.
* [GitHub Pages](https://11ty.github.io/eleventy-base-blog/)
## Getting Started
### 1. Clone this repository:
```
git clone https://github.com/11ty/eleventy-base-blog.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 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/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.