Skip to content

Commit

Permalink
Merge pull request #702 from hacspec/make-readme-links-absolute
Browse files Browse the repository at this point in the history
fix(README): always begin relative path with `./`, rewrite in action
  • Loading branch information
W95Psp authored Jun 5, 2024
2 parents 3444df7 + e839f11 commit 706a1ca
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/workflows/push_readme.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,13 @@ jobs:
cat hax/README.md
) > website/README.md
cd website
# Replace the `🌐 Website` link to a GitHub link
sed -i 's#.*🌐 Website.*# <a href="https://github.com/hacspec/hax">🔗 GitHub</a> |#' README.md
# Replace relative links to absolute links
sed -i 's|(\./|(https://github.com/hacspec/hax/tree/main/|g' README.md
git config --local user.name "github-actions[bot]"
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add -A
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Here are some resources for learning more about hax:
- [Book](https://hacspec.org/book) (work in progress)
+ [Quick start](https://hacspec.org/book/quick_start/intro.html)
+ [Tutorial](https://hacspec.org/book/tutorial/index.html)
- [Examples](examples/): the [examples directory](examples/) contains
- [Examples](./examples/): the [examples directory](./examples/) contains
a set of examples that show what hax can do for you.

## Usage
Expand Down

0 comments on commit 706a1ca

Please sign in to comment.