Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sootyowl/site-template

A dockerised, minimal setup of 11ty (https://www.11ty.dev) static site generator with support for Obsidian wikilinks and templated layouts.
https://github.com/sootyowl/site-template

11ty docker-compose markdown-to-html obsidian-md

Last synced: 2 days ago
JSON representation

A dockerised, minimal setup of 11ty (https://www.11ty.dev) static site generator with support for Obsidian wikilinks and templated layouts.

Awesome Lists containing this project

README

        

# Site template

A simple & fast HTML site built with [11ty](https://www.11ty.dev/) featuring:

- Markdown content with frontmatter
- Wiki-style internal linking between pages using `[[links]]`
- Docker containerization
- Custom Nunjucks layouts

Intended as a boilerplate for a personal blog/site/wiki based on an Obsidian-like workflow.
Many options for customization and extension are available through the Eleventy ecosystem, see the [Eleventy documentation](https://www.11ty.dev/docs/) for more information.

## Development

### Prerequisites

- Node.js
- Docker (optional)

### Local Development

1. Install dependencies:
```sh
npm install
```

2. Start the development server:
```sh
npx @11ty/eleventy --serve
```

The site will be available at http://localhost:8080

### Docker Development

To run using Docker:

```sh
docker compose up
```

The site will be available at http://localhost:8080 with live content reloading from the `content` directory.

## Project Structure

- `content/` - Markdown content files and layouts
- `content/_includes/` - Nunjucks layout templates
- `eleventy.config.js` - Eleventy configuration
- `Dockerfile` - Container definition
- `docker-compose.yml` - Container orchestration

## Dependencies

- [@11ty/eleventy](https://www.11ty.dev/) - Static site generator
- [@photogabble/eleventy-plugin-interlinker](https://github.com/photogabble/eleventy-plugin-interlinker) - Wiki-style internal linking