Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ar363/eleventy-stylus-blog-theme

Repository for a template blog website built out using Eleventy static site generator and Stylus CSS preprocessor
https://github.com/ar363/eleventy-stylus-blog-theme

11ty 11ty-blog 11ty-starter blog eleventy eleventy-template eleventy-website stylus stylus-css theme

Last synced: about 1 month ago
JSON representation

Repository for a template blog website built out using Eleventy static site generator and Stylus CSS preprocessor

Awesome Lists containing this project

README

        

# Eleventy + Stylus Blog theme

[![Netlify Status](https://api.netlify.com/api/v1/badges/a180e099-11d2-49d4-9697-910d56980343/deploy-status)](https://app.netlify.com/sites/eleventy-stylus-blog-theme/deploys)
[![Build Status](https://travis-ci.com/ar363/eleventy-stylus-blog-theme.svg?branch=main)](https://travis-ci.com/ar363/eleventy-stylus-blog-theme)
[![Vercel Status](https://vercel-badge-ar363.vercel.app/?app=eleventy-stylus-blog-theme)](https://github.com/ar363/eleventy-stylus-blog-theme/deployments/activity_log?environment=Production)

A theme repository that contains a blog built with [Eleventy](https://github.com/11ty/eleventy) and [Stylus](https://stylus-lang.com/)

## Features
- 100% Lighthouse scores
- Toggleable dark theme (PS. theme preference is also stored in `localStorage`)
- Tags as taxonomy
- Stylus CSS preprocessor
- Integrated with Eleventy's official [navigation plugin](https://www.11ty.dev/docs/plugins/navigation/)
- Also generates Atom RSS Feed with Eleventy's official [RSS plugin](https://www.11ty.dev/docs/plugins/rss/)
- Sitemap generation
- Non-post pages support (eg. About page, Contact page)
- Modular type scale implemented in with Stylus

## Demos

- Vercel: https://eleventy-stylus-blog-theme.vercel.app/
- Netlify: https://eleventy-stylus-blog-theme.netlify.app/
- Github Pages: https://ar363.github.io/eleventy-stylus-blog-theme/

## Screenshots

Light theme
![light theme website homepage screenshot](screenshot.png?raw=true)

Dark theme
![dark theme website homepage screenshot](screenshot-dark.png?raw=true)

## Deploy this template to your own site

Get your site up and running with a few clicks

- [Deploy on Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/ar363/eleventy-stylus-blog-theme)
- [Deploy on Vercel](https://vercel.com/import/project?template=ar363%2Feleventy-stylus-blog-theme)

## Prerequisites for local development
[Node.js LTS](https://nodejs.org/en/)

## Getting started locally

1. Clone this repo
```
git clone https://github.com/ar363/eleventy-stylus-blog-theme my-blog
```

2. Navigate to the blog directory
```
cd my-blog
```

3. Install dependencies
```
npm i
```
4. Edit `_data/site.js` according to your site preferences

5. Also optionally modify `stylus/abstracts/variables.styl` according to your preference

To watch for changes in Eleventy and Stylus, use `npm run dev`

To build without watching for changes, use `npm run build`