Skip to content

Commit

Permalink
Add information about optionally quoting bookmark URLs to README.
Browse files Browse the repository at this point in the history
refs gh-330
  • Loading branch information
xwmx committed Jul 13, 2024
1 parent 3212efb commit dd8dd90
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1771,6 +1771,14 @@ is installed, markup is cleaned up to focus on content. When
JavaScript-dependent pages are rendered and the resulting markup is
saved.

Many shells automatically escape special characters in URLs. If a
URL contains characters that are preventing it from being saved in full,
URLs can also be enclosed in quotes when passed to `nb`:

```bash
nb "https://example.com#sample-anchor"
```

In addition to caching the page content,
you can also include a quote from the page in a
[`## Quote`](#-quote) section
Expand Down
8 changes: 8 additions & 0 deletions docs/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -1777,6 +1777,14 @@ is installed, markup is cleaned up to focus on content. When
JavaScript-dependent pages are rendered and the resulting markup is
saved.

Many shells automatically escape special characters in URLs. If a
URL contains characters that are preventing it from being saved in full,
URLs can also be enclosed in quotes when passed to `nb`:

```bash
nb "https://example.com#sample-anchor"
```

In addition to caching the page content,
you can also include a quote from the page in a
[`## Quote`](#-quote) section
Expand Down

0 comments on commit dd8dd90

Please sign in to comment.