https://github.com/cable8mm/eleventy-theme

This is the official eleventy theme for Document2
https://github.com/cable8mm/eleventy-theme

document2 eleventy theme

Last synced: 3 days ago
JSON representation

This is the official eleventy theme for Document2

• Host: GitHub
• URL: https://github.com/cable8mm/eleventy-theme
• Owner: cable8mm
• License: mit
• Created: 2024-04-11T05:30:07.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-04-12T14:27:38.000Z (6 months ago)
• Last Synced: 2024-09-20T11:35:20.356Z (8 days ago)
• Topics: document2, eleventy, theme
• Language: HTML
• Homepage: https://github.com/cable8mm/document2
• Size: 505 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Eleventy theme for Document2

[![js-tests](https://github.com/cable8mm/eleventy-theme/actions/workflows/js-tests.yml/badge.svg)](https://github.com/cable8mm/eleventy-theme/actions/workflows/js-tests.yml)

![GitHub Release](https://img.shields.io/github/v/release/cable8mm/eleventy-theme)

![GitHub License](https://img.shields.io/github/license/cable8mm/eleventy-theme)

This is the official eleventy theme for [Document2](https://github.com/cable8m/document2).

## Features

- [x] JAM stack supported

- [x] Tailwindcss and Vite

- [x] Dark Mode

- [x] Integration with the Document2

![Eleventy Theme Preview](https://cabinet.palgle.com/eleventy-theme-preview.png)

## Local Development

If you want to work on this project on your local machine, you may follow the instructions below.:

1. Fork this repository

2. Open your terminal and `cd` to your project folder

3. Clone your fork into the project folder, by running the following command *with your username placed into the {username} slot*:

```bash

git clone [email protected]:{username}/eleventy-theme eleventy-theme

```

4. CD into the new directory you just created:

```bash

cd eleventy-theme

```

5. Run the `npm install` script, which will take all the steps necessary to prepare your local install:

```bash

npm install

```

6. Run the `npm run dev` script, which will provide local web server to `http://localhost:{port}`

```bash

npm run dev

```

### Syncing Upstream Changes Into Your Fork

This [GitHub article](https://help.github.com/en/articles/syncing-a-fork) provides instructions on how to pull the latest changes from this repository into your fork.