Skip to content

Commit e1a4fa6

Browse files
authored
docs: improve footnote formatting
1 parent b114948 commit e1a4fa6

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -142,13 +142,10 @@ cargo clippy
142142
### Download puzzle inputs via aoc-cli
143143

144144
1. Install [`aoc-cli`](https://github.com/scarvalhojr/aoc-cli/) via cargo: `cargo install aoc-cli`.
145-
2. Create an `.adventofcode.session` file in your home directory and paste your session cookie into it. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out the `session` cookie value.
145+
2. Create an `.adventofcode.session` file in your home directory and paste your session cookie[^1] into it. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out the `session` cookie value.
146146

147147
Once installed, you can use the [download command](#download-inputs-for-a-day).
148148

149-
> **Note**
150-
> The session cookie might expire after a while (~1 month) which causes the downloads to fail. To fix this issue, refresh the `.adventofcode.session` file.
151-
152149
### Enable clippy lints in CI
153150

154151
Uncomment the `clippy` job in the `ci.yml` workflow to enable clippy checks in CI.
@@ -170,19 +167,14 @@ Go to the _Secrets_ tab in your repository settings and create the following sec
170167
- `AOC_ENABLED`: This variable controls whether the workflow is enabled. Set it to `true` to enable the progress tracker.
171168
- `AOC_USER_ID`: Go to [this page](https://adventofcode.com/settings) and copy your user id. It's the number behind the `#` symbol in the first name option. Example: `3031`
172169
- `AOC_YEAR`: the year you want to track. Example: `2021`
173-
- `AOC_SESSION`: an active session for the advent of code website. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out the `session` cookie.
174-
175-
> **Note**
176-
> The session cookie might expire after a while (~1 month) which causes the automated workflow to fail. To fix this issue, refresh the `AOC_SESSION` secret.
170+
- `AOC_SESSION`: an active session[^2] for the advent of code website. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out the `session` cookie.
177171

178172
### Use VS Code to debug your code
179173

180174
1. Install [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) and [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb).
181-
2. Set breakpoints in your code. [^1]
182-
3. Click _Debug_ next to the unit test or the _main_ function. [^2]
183-
4. The debugger will halt your program at the specific line and allow you to inspect the local stack. [^3]
184-
185-
---
175+
2. Set breakpoints in your code. [^3]
176+
3. Click _Debug_ next to the unit test or the _main_ function. [^4]
177+
4. The debugger will halt your program at the specific line and allow you to inspect the local stack. [^5]
186178

187179
## Useful crates
188180

@@ -198,6 +190,8 @@ Do you have aoc-specific crate recommendations? [Share them!](https://github.com
198190

199191
## Footnotes
200192

201-
[^1]: <img src="https://user-images.githubusercontent.com/1682504/198838369-453dc22c-c645-4803-afe0-fc50d5a3f00c.png" alt="Set a breakpoint" width="400" />
202-
[^2]: <img alt="Run debugger" src="https://user-images.githubusercontent.com/1682504/198838372-c89369f6-0d05-462e-a4c7-8cd97b0912e6.png" width="400" />
203-
[^3]: <img alt="Inspect debugger state" src="https://user-images.githubusercontent.com/1682504/198838373-36df6996-23bf-4757-9335-0bc4c1db0276.png" width="600" />
193+
[^1]:The session cookie might expire after a while (~1 month) which causes the downloads to fail. To fix this issue, refresh the `.adventofcode.session` file.
194+
[^2]: The session cookie might expire after a while (~1 month) which causes the automated workflow to fail. To fix this issue, refresh the AOC_SESSION secret.
195+
[^3]: <img src="https://user-images.githubusercontent.com/1682504/198838369-453dc22c-c645-4803-afe0-fc50d5a3f00c.png" alt="Set a breakpoint" width="450" />
196+
[^4]: <img alt="Run debugger" src="https://user-images.githubusercontent.com/1682504/198838372-c89369f6-0d05-462e-a4c7-8cd97b0912e6.png" width="450" />
197+
[^5]: <img alt="Inspect debugger state" src="https://user-images.githubusercontent.com/1682504/198838373-36df6996-23bf-4757-9335-0bc4c1db0276.png" width="450" />

0 commit comments

Comments
 (0)