-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update README.md with project structure and commands
- Loading branch information
Showing
1 changed file
with
35 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |