Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,29 @@ repos:
rev: v6.0.0
hooks:
- id: trailing-whitespace
args: [--markdown-linebreak-ext=md]
- id: end-of-file-fixer
- id: fix-byte-order-marker
name: run fix-byte-order-marker
description: removes UTF-8 byte order marker
- id: forbid-submodules
name: run forbid-submodules
description: forbids any submodules in the repository
- id: check-yaml
- id: check-added-large-files
- id: check-json
- id: check-merge-conflict
- id: check-case-conflict
- id: check-vcs-permalinks
name: run check-vcs-permalinks
description: ensures that links to vcs websites are permalinks
- id: detect-aws-credentials
name: run detect-aws-credentials
description: checks for the existence of AWS secrets that you have set up with the AWS CLI
args: [--allow-missing-credentials]
- id: detect-private-key
name: run detect-private-key
description: checks for the existence of private keys
- id: mixed-line-ending

- repo: https://github.com/pre-commit/mirrors-prettier
Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@

## 🎯 About the Project

NextCommunity is a static site directory built with [Eleventy (11ty)](https://www.11ty.dev/) that celebrates the global developer community. Each developer gets their own profile page showcasing their skills, bio, and social links.
NextCommunity is a static site directory built with [Eleventy (11ty)](https://www.11ty.dev/), styled with
[TailwindCSS](https://tailwindcss.com/) and made interactive with JavaScript. NextCommunity celebrates the global
developer community. Each developer gets their own profile page showcasing their skills, bio, and social links.

### 🛠️ Tech Stack

Expand Down Expand Up @@ -153,19 +155,19 @@ git push origin main
| `github` | Your GitHub username (without @) | `jbampton` |
| `country` | Your country | `Australia` |
| `location` | Your city | `Brisbane` |
| `role` | Your professional title | `Frontend Developer` |
| `languages` | Space-separated list of technologies | `JavaScript React Node.js` |
| `role` | Your professional title | `Scrum Master` |
| `languages` | Space-separated list of technologies | `JavaScript, Python, Ruby` |
| `bio` | Multi-line biography | See template above |

### Optional Fields

| Field | Description | Example |
| ----------- | -------------------------- | ---------------------------------- |
| `website` | Your personal website URL | `https://yoursite.com` |
| `email` | Your email address | `you@example.com` |
| `instagram` | Full Instagram profile URL | `https://instagram.com/username` |
| `twitter` | Full Twitter/X profile URL | `https://twitter.com/username` |
| `linkedin` | Full LinkedIn profile URL | `https://linkedin.com/in/username` |
| `twitter` | Full Twitter/X profile URL | `https://twitter.com/username` |
| `website` | Your personal website URL | `https://yoursite.com` |

### Field Guidelines

Expand Down Expand Up @@ -227,7 +229,7 @@ Want to contribute to the project code or test your profile locally? Here's how

```bash
# Clone the repository
git clone https://github.com/jbampton/NextCommunity.github.io.git
git clone https://github.com/NextCommunity/NextCommunity.github.io.git
cd NextCommunity.github.io

# Install dependencies
Expand Down Expand Up @@ -407,6 +409,6 @@ This project is licensed under the **GNU General Public License v3.0** - see the

## 📞 Contact & Support

- **Report bugs**: [Open an issue](https://github.com/jbampton/NextCommunity.github.io/issues)
- **Ask questions**: [Start a discussion](https://github.com/jbampton/NextCommunity.github.io/discussions)
- **Report bugs**: [Open an issue](https://github.com/NextCommunity/NextCommunity.github.io/issues)
- **Ask questions**: [Start a discussion](https://github.com/NextCommunity/NextCommunity.github.io/discussions)
- **Maintainer**: [@jbampton](https://github.com/jbampton)