Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
koalanis authored Sep 4, 2023
1 parent 9397512 commit 911db8a
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ npm install --save @koalanis/advent-pages
npx @koalanis/advent-pages generate
```

## Configuration
### Configuration
The static site's metadata is configured in a `advent.config.json` file.
```json
{
Expand All @@ -39,14 +39,19 @@ The fields `days[n].partOneDone` and `days[n].partOneTwo` are booleans that sign

The other fields in `days[n]`, such as `testDataOne`, `codeOne`, etc, are relative paths that are used to inject source text blobs into the static site for display. You can use this to display your advent data & answers, and most importantly, your code solutions.

### Github workflow
You can configure this static site generator to work in combination of a github action to add publishing of the static onto your advent of code github repositories. For a template of doing this, take a look at my [starter](https://github.com/koalanis/advent-template).
#### Example
Python Advent of Code 2015 [link](https://koalanis.github.io/advent-python-2015/)

## details
- built using [tsup](https://tsup.egoist.dev/)
- default styling using [NES.css](https://nostalgic-css.github.io/NES.css/)

## roadmap
- [x] publish npm package
- [ ] add custom theming support
- [ ]


## lastly
the static site is styled in [NES.css](https://github.com/nostalgic-css/NES.css)https://github.com/nostalgic-css/NES.css
Expand Down

0 comments on commit 911db8a

Please sign in to comment.