From dd8dd9093bc81f6ea8475c16b23dbb4e43c3d178 Mon Sep 17 00:00:00 2001 From: William Melody Date: Fri, 12 Jul 2024 19:22:05 -0700 Subject: [PATCH] Add information about optionally quoting bookmark URLs to README. refs gh-330 --- README.md | 8 ++++++++ docs/index.markdown | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/README.md b/README.md index 0bec8dea5..7ed3ed0a2 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/index.markdown b/docs/index.markdown index 5615e22b8..bc1e87824 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -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