Merge pull request #162 from Stardown-app/docs

Improve documentation

README.md

@@ -21,16 +21,21 @@
 
 <p align="center"><img alt="demo gif" src="https://github.com/Stardown-app/assets/blob/main/Stardown.gif"></p>
 
-* Press `Alt+C` (Mac: `⌥+C`) to copy a selection or a page's link.
-* Press `Alt+N` (Mac: `⌥+N`) to open a notepad that copying with Stardown automatically pastes into.
-* Right-click part of a page to copy it as markdown. Select before right-clicking to copy multiple parts.
-* Copy links for all tabs. Select tabs first to copy links for only those tabs.
-* Customize these features including keyboard shortcuts in Stardown's settings.
+Copy and paste like you're used to. Press `Alt+C` to copy (Mac: `⌥+C`).
+
+- Copy almost anything as markdown including links, images, videos, lists, bold, italics, quotes, code blocks, etc.
+- Copy tables as markdown, CSV, JSON, and more.
+- Automatically extract the main content of pages.
+- Copy links for the current tab or all tabs. Select tabs to copy links for those tabs.
+- Instantly clip into a note using Stardown's sidebar notepad to simultaneously copy and paste.
+- Create [text fragments](https://developer.mozilla.org/en-US/docs/Web/URI/Fragment/Text_fragments) so you can link to specific parts of pages.
 
 <!--
 Stardown is free except that if you get it from Apple's App Store, there is a small fee to help cover the $99 USD per year cost I'm paying to keep Stardown available in the App Store.
 -->
 
+We're still finding sites where Stardown doesn't work as well as it could. If you find one, please [create an issue](https://github.com/Stardown-app/Stardown/issues) if one doesn't exist for it yet.
+
 ## Privacy
 
 Stardown will never sell any data to anyone and does not collect any personal data. Everything you copy with Stardown is stored in your clipboard, local files, and/or your browser's settings depending on which features you use. Stardown's optional notepad saves to your browser's settings.
@@ -48,13 +53,3 @@ You're welcome to [make a feature request](https://github.com/Stardown-app/Stard
 Contributions are welcome! Let me know (such as in [an issue](https://github.com/Stardown-app/Stardown/issues) or [a discussion](https://github.com/Stardown-app/Stardown/discussions)) what you have in mind ahead of time if you think there's a chance it won't be approved.
 
 Also, please read [./docs/develop.md](docs/develop.md).
-
-## Why Stardown?
-
-Stardown is:
-
-* **Flexible**. Integrates well with many workflows. Select almost anything, copy and paste anywhere.
-* **Instantly clip** into a note using Stardown's sidebar notepad to both copy and paste with `Alt+C` (Mac: `⌥+C`).
-* **Better at converting**. Stardown's custom code for converting HTML to markdown can convert more formatting than alternatives.
-* **Creates [text fragments](https://developer.mozilla.org/en-US/docs/Web/URI/Fragment/Text_fragments)** so you can link to specific parts of pages.
-* **Extensible**. Stardown is designed to be extended for more markdown flavors and other markup languages.

docs/alternatives.md

@@ -10,7 +10,8 @@ You can use this [bookmarklet](https://en.wikipedia.org/wiki/Bookmarklet) I made
 
 ## Integrate directly with an editor
 
-* [Obsidian Clipper](https://github.com/obsidianmd/obsidian-clipper) is the official web clipper extension for Obsidian.
+* Some editors like Word and Obsidian try to convert pasted HTML automatically, but the result often has formatting errors and important parts missing because they can only see what's in the clipboard. Converting correctly often requires seeing more than just what was selected, which browser extensions can do.
+* [Obsidian Clipper](https://github.com/obsidianmd/obsidian-clipper)
 * [Notion Web Clipper](https://www.notion.so/web-clipper)
 * [Evernote Web Clipper](https://evernote.com/features/webclipper)
 * [Joplin web clipper](https://github.com/laurent22/joplin/blob/dev/readme/apps/clipper.md)
@@ -21,7 +22,7 @@ You can use this [bookmarklet](https://en.wikipedia.org/wiki/Bookmarklet) I made
 * [linkding](https://github.com/sissbruecker/linkding) is a self-hosted bookmarks manager.
 * [Raindrop.io](https://raindrop.io/) is an online bookmarks manager.
 * [Readwise](https://readwise.io/) can sync highlights from websites, Kindles, iBooks, and more.
-* [Zotero](https://www.zotero.org/) is one of the best tools for saving and organizing research.
+* [Zotero](https://www.zotero.org/) is one of the best tools for saving and organizing research articles and citations.
 * [HTML to React & Figma by Magic Patterns](https://chromewebstore.google.com/detail/html-to-react-figma-by-ma/chgehghmhgihgmpmdjpolhkcnhkokdfp)
 * [Send To Logseq](https://chromewebstore.google.com/detail/send-to-logseq/mgdccnefjlmhnfbmlnhddoogimbpmilj) is a browser extension that saves web pages to [Logseq](https://github.com/logseq/logseq?tab=readme-ov-file).
 * [github.com/jsartelle/vscode-web-clipper](https://github.com/jsartelle/vscode-web-clipper) is a VS Code extension.
@@ -49,7 +50,7 @@ You can use this [bookmarklet](https://en.wikipedia.org/wiki/Bookmarklet) I made
 * [you-get](https://github.com/soimort/you-get) is a tiny command-line utility to download media contents (videos, audios, images) from the Web.
 * [Reader-LM](https://jina.ai/news/reader-lm-small-language-models-for-cleaning-and-converting-html-to-markdown/?nocache=1) is small language models that convert HTML to markdown.
 * [Epublifier](https://github.com/maoserr/epublifier) converts some webnovels to epub format.
-* [FanFicFare](https://github.com/JimmXinu/FanFicFare) is a tool for making eBooks from stories on fanfiction and other web sites.
+* [FanFicFare](https://github.com/JimmXinu/FanFicFare) is a tool for making eBooks from stories on fanfiction and other websites.
 
 ## Paste structured data
 

docs/manual-testing.md

@@ -19,6 +19,7 @@ Here are a bunch of web pages with interesting features for testing.
 - [table with link images](https://en.wikipedia.org/wiki/1926_World_Table_Tennis_Championships)
 - [table with horizontally spanned image](https://en.wikipedia.org/wiki/Toshimi_Kitazawa)
 - [table with vertically spanned image](https://en.wikipedia.org/wiki/Gabiadji)
+- [table of numbers (mostly)](https://finance.yahoo.com/quote/%5EGSPC/history/)
 - [massive table](https://www.worldometers.info/world-population/population-by-country/)
 - [tables used for presentation without the presentation role](https://news.ycombinator.com/)
 - [code blocks that use `<pre>` but not `<code>`](https://www.cnblogs.com/unity2018/p/8492463.html)

src/background.js

@@ -244,15 +244,16 @@ async function handleInteraction(tab, message, options = {}, successStatus = 1)
         await showStatus(0, 'Error', 'Stardown cannot run on PDFs');
         return;
     } else if (
+        // it's an extension store
         tab.url.startsWith('https://chromewebstore.google.com') ||
         tab.url.startsWith('https://microsoftedge.microsoft.com/addons') ||
         tab.url.startsWith('https://addons.mozilla.org') ||
         tab.url.startsWith('https://addons.opera.com')
     ) {
-        await showStatus(0, 'Error', 'Stardown cannot run in extension stores');
+        await showStatus(0, 'Error', 'This page is protected by the browser');
         return;
     } else if (tab.url.startsWith('https://support.mozilla.org')) {
-        await showStatus(0, 'Error', 'Stardown cannot run on Mozilla support pages');
+        await showStatus(0, 'Error', 'This page is protected by the browser');
         return;
     }
 

src/getSetting.js

@@ -32,7 +32,7 @@ const defaultSettings = {
     mdSubBrackets: 'underlined',
     mdBulletPoint: '-',
     mdSelectionWithSourceTemplate: `> [!note]
-> from [{{link.title}}]({{link.url}}) on {{date.YYYYMMDD}}
+> from [{{page.title}}]({{page.url}}) on {{date.YYYYMMDD}}
 
 {{text}}
 `,

src/settings.html

@@ -187,7 +187,7 @@ <h4>Markdown</h4>
         "Copy selection with source" template:</label>
       <textarea id="mdSelectionWithSourceTemplate" name="mdSelectionWithSourceTemplate" rows="5" cols="75">
 > [!note]
-> from [{{link.title}}]({{link.url}}) on {{date.YYYYMMDD}}
+> from [{{page.title}}]({{page.url}}) on {{date.YYYYMMDD}}
 
 {{text}}
 </textarea>

src/settings.js

@@ -141,7 +141,7 @@ async function validateTemplateVariables() {
     const YYYYMMDD = '2024-01-01';
     const text = 'converted text';
     const templateVars = {
-        link: { title, url },
+        page: { title, url },
         date: { YYYYMMDD },
         text,
     };