https://github.com/jwstegemann/tytest

https://github.com/jwstegemann/tytest

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jwstegemann/tytest
• Owner: jwstegemann
• Created: 2022-01-21T07:48:36.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-01-21T10:24:19.000Z (almost 3 years ago)
• Last Synced: 2024-10-18T11:52:06.701Z (26 days ago)
• Language: Nunjucks
• Size: 188 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Minimal 11ty Starter

![Image showing the demo website](https://user-images.githubusercontent.com/3286735/100862193-26c1bd00-3493-11eb-8120-61a0d822588b.png)

A *very* minimal [eleventy](https://11ty.io/) starter using [Tailwind CSS](https://tailwindcss.com/) for styling.

It features a smart navigation component that sets active states automatically.

For beginners and/or when you need a simple static site and don't want to duplicate your navigation header and set active states for the nth time.

## Features

🦴 As minimal as possible  

⚡️ Active states in the navigation are automatically set based on the current url.  

💨 Add a couple of lines to any page and it will appear in the navigation. (Check how to below)  

🗓 A very simple blog structure because why not  

🍪 Example for including json data on contact page  

💜 Tailwind CSS

### [Live Demo](https://clever-newton-cbb08a.netlify.app)  

---

## Getting Started

#### 1. Clone this repo

```

git clone [email protected]:tomreinert/minimal-11ty-tailwind-starter.git mysite

```

#### 2. Change into the working directory

```

cd mysite

```

#### 3. Install dependencies

```

npm install

```

#### 4. Work locally

Watches for changes and serves locally on http://localhost:8080

```

npm run serve

```

#### 5. Create a production build

```

npm run build

```

## How To: Navigation

The top navigation is the only *feature* in this starter and lives in `/src/_includes/components/navigation.njk`.  

It looks for the eleventyNavigation object in pages and adds them to the navigation bar. It also checks whether the site's url is in the currently opened url and highlights the navigation item accordingly. This even works for subpages. So if you're on `/blog/post/` the **Blog** nav item will still be active.

### Adding links to the navigation

Add the `eleventyNavigation` object to any page and it will appear in the navigation. Optionally set the order of your items.

Check the [11ty docs](https://www.11ty.dev/docs/plugins/navigation/) for more information about the navigation plugin.

```

---

eleventyNavigation:

  key: Your Page Name

  order: 1

---

```

### Changing the navigation item styles

The script in `/_includes/components/navigation.njk` checks if a navigation item is active and styles it accordingly.

Let's dissect the code:

```



 {{ entry.title }}



```

## How To: Blog

Add a page in `_src/blog/posts` and it will appear in the post list.

## Credits

[Bryan L. Robinson](https://bryanlrobinson.com/blog/using-nunjucks-if-expressions-to-create-an-active-navigation-state-in-11ty/) for explaining how to create the active navigation state

 https://statickit.com/guides/eleventy-tailwind - I set up the project according to this guide

 https://11ty.io/

 https://tailwindcss.com/