Skip to content

Commit

Permalink
docs: Update README.md with project structure and commands
Browse files Browse the repository at this point in the history
  • Loading branch information
EdRW committed Jul 10, 2024
1 parent a11e5b3 commit 0bcd3a3
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# Hello World
# EdRW.codes 😸

The source code for my personal website, [EdRW.codes](https://edrw.codes).

## Project Structure

- [`_data/`](./_data) - site metadata files
- [`_includes/`](./_includes) - Nunjucks layouts and partials
- [`fragments/`](./_includes/fragments) - Nunjucks partials for specific components
- [`layouts/`](./_includes/layouts) - Nunjucks layout templates
- [`contents/`](./contents) - Nunjucks and Markdown content files
- `dist/` - Output directory for Eleventy (generated on build)
- [`plugins/`](./plugins) - Custom Eleventy plugins and configurations
- [`public/`](./public) - Static assets (images, CSS, webfonts, etc.)
- [`eleventy.config.js` ](./eleventy.config.js) - Eleventy configuration file

## Installation

```bash
pnpm install
```

## Commands

```bash
pnpm serve
```

```bash
pnpm build
```

```bash
pnpm clean
```

0 comments on commit 0bcd3a3

Please sign in to comment.