Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/defite/kaktus-11ty

11ty theme for personal micro-blog
https://github.com/defite/kaktus-11ty

11ty 11ty-template 11ty-theme cloudinary eleventy eleventy-template static-site-generator

Last synced: 13 days ago
JSON representation

11ty theme for personal micro-blog

Awesome Lists containing this project

README

        

# kaktus-11ty

A tribute to kaktus theme built with [11ty](https://github.com/11ty/eleventy) static site generator.

![kaktus-11ty](https://user-images.githubusercontent.com/299118/193879690-acf0f384-d259-4c06-a981-c7136f64fc10.png)

## Getting Started

### 1. Clone this Repository

```
git clone https://github.com/Defite/kaktus-11ty.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
```

### 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.

### Cloudinary support

Go to `.eleventy.js`, find Cloudinary section and uncomment two strings:

```js
eleventyConfig.cloudinaryCloudName = "demo";
eleventyConfig.hostname = "demo";
```

Replace with your Cloudinary values.

To use images in posts, use shortcode:

```md
{% respimg
src="/img/sample.jpeg",
width="520",
sizes="500, 1000",
alt="Simple Pic",
loading="lazy"
%}
```

### Profile info etc

All metadata is stored in `_data/metadata.json`. You can set everything there.