feat: open external links in new tab (foundry-rs#1099)

Closes foundry-rs#1096
matter-labs · Jan 24, 2024 · f849158 · f849158
1 parent f534e4a
commit f849158
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -10,8 +10,10 @@ jobs:
     name: Deploy to Cloudflare Pages
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-
+        uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Install mdbook-external-links
+        run: cargo install mdbook-external-links
       - name: Install mdbook
         run: |
           mkdir mdbook

diff --git a/README.md b/README.md
@@ -11,6 +11,8 @@ Check our [contributing guidelines](./CONTRIBUTING.md). Feel free to contribute
 
 The book is build with [mdbook](https://github.com/rust-lang/mdBook), which you can get by running `cargo install mdbook`.
 
+The book also requires [`mdbook-external-links`](https://github.com/jonahgoldwastaken/mdbook-external-links): `cargo install mdbook-external-links`.
+
 To see the book change live run:
 
 ```sh

diff --git a/book.toml b/book.toml
@@ -9,6 +9,8 @@ description = "A book on all things Foundry"
 [build]
 create-missing = false
 
+[preprocessor.external-links]
+
 [output.html]
 git-repository-url = "https://github.com/foundry-rs/book"
 edit-url-template = "https://github.com/foundry-rs/book/edit/master/{path}"
-Original file line number
+Diff line change
@@ Expand Up @@
     The book is build with [mdbook](https://github.com/rust-lang/mdBook), which you can get by running `cargo install mdbook`.
+    The book also requires [`mdbook-external-links`](https://github.com/jonahgoldwastaken/mdbook-external-links): `cargo install mdbook-external-links`.
     To see the book change live run:
     ```sh
@@ Expand Down @@