[pull] master from foambubble:master

.all-contributorsrc

@@ -1058,6 +1058,15 @@
  "contributions": [
  "doc"
  ]
+ },
+ {
+ "login": "dcarosone",
+ "name": "Daniel Carosone",
+ "avatar_url": "https://avatars.githubusercontent.com/u/11495017?v=4",
+ "profile": "https://github.com/dcarosone",
+ "contributions": [
+ "doc"
+ ]
  }
  ],
  "contributorsPerLine": 7,

.github/workflows/update-docs.yml

@@ -6,6 +6,8 @@ on:
  - master
  paths:
  - docs/user/**/*
+ - docs/.vscode/**/*
+ - docs/assets/**/*
  workflow_dispatch:
 
 jobs:
@@ -20,11 +22,15 @@ jobs:
  - uses: actions/checkout@v3
  with:
  path: foam
- - name: Copy and fixup user docs files 
+ - name: Copy and fixup user docs files
  id: copy
  run: |
  rm -r foam-template/docs
+ rm -r foam-template/assets
+ rm -r foam-template/.vscode
  cp -r foam/docs/user foam-template/docs
+ cp -r foam/docs/assets foam-template/assets
+ cp -r foam/docs/.vscode foam-template/.vscode
 
  # Strip autogenerated wikileaks references because
  # they are not an appropriate default user experience.

docs/.vscode/extensions.json

@@ -5,17 +5,11 @@
  // Foam's own extension
  "foam.foam-vscode",
 
- // Prettier for auto formatting code
- "esbenp.prettier-vscode",
-
- // GitLens for seeing version history inline
- "eamodio.gitlens",
-
  // Tons of markdown goodies (lists, tables of content, so much more)
  "yzhang.markdown-all-in-one",
 
- // Graph visualizer
- "tchayen.markdown-links",
+ // Prettier for auto formatting code
+ "esbenp.prettier-vscode",
 
  // Understated grayscale theme (light and dark variants)
  "philipbe.theme-gray-matter"

docs/.vscode/keybindings.json

@@ -3,6 +3,6 @@
 [
  {
  "key": "cmd+shift+n",
- "command": "vscodeMarkdownNotes.newNote"
+ "command": "foam-vscode.create-note"
  }
 ]

docs/.vscode/settings.json

@@ -5,29 +5,18 @@
  "editor.overviewRulerBorder": false,
  "editor.lineHeight": 24,
  "foam.edit.linkReferenceDefinitions": "withExtensions",
- "vscodeMarkdownNotes.noteCompletionConvention": "noExtension",
  "[markdown]": {
  "editor.quickSuggestions": {
  "other": true,
  "comments": false,
  "strings": false
  }
  },
- "cSpell.language": "en-GB",
  "git.enableSmartCommit": true,
  "git.postCommitCommand": "sync",
- "spellright.language": [
- "en"
- ],
- "spellright.documentTypes": [
- "markdown",
- "plaintext"
- ],
  "files.exclude": {
  "_site/**": true
  },
  "files.insertFinalNewline": true,
- "markdown.styles": [
- ".vscode/custom-tag-style.css"
- ]
+ "markdown.styles": [".vscode/custom-tag-style.css"]
 }

docs/index.md

@@ -255,6 +255,7 @@ If that sounds like something you're interested in, I'd love to have you along o
  <td align="center" valign="top" width="14.28%"><a href="https://amnesiak.org/me"><img src="https://avatars.githubusercontent.com/u/952059?v=4?s=60" width="60px;" alt="Tony Cheneau"/><br /><sub><b>Tony Cheneau</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=tcheneau" title="Documentation">📖</a></td>
  <td align="center" valign="top" width="14.28%"><a href="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/nicholas-l"><img src="https://avatars.githubusercontent.com/u/12977174?v=4?s=60" width="60px;" alt="Nicholas Latham"/><br /><sub><b>Nicholas Latham</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=nicholas-l" title="Code">💻</a></td>
  <td align="center" valign="top" width="14.28%"><a href="https://thara.dev"><img src="https://avatars.githubusercontent.com/u/1532891?v=4?s=60" width="60px;" alt="Tomochika Hara"/><br /><sub><b>Tomochika Hara</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=thara" title="Documentation">📖</a></td>
+ <td align="center" valign="top" width="14.28%"><a href="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/dcarosone"><img src="https://avatars.githubusercontent.com/u/11495017?v=4?s=60" width="60px;" alt="Daniel Carosone"/><br /><sub><b>Daniel Carosone</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=dcarosone" title="Documentation">📖</a></td>
  </tr>
  </tbody>
 </table>

docs/user/features/built-in-note-embedding-types.md

@@ -0,0 +1,29 @@
+# Built-In Note Embedding Types
+
+When embedding a note, there are a few ways to modify the scope of the content as well as its display style. The following are Foam keywords that are used to describe note embedding.
+
+Note, this only applies to note embedding, not embedding of attachments or images.
+
+![Note Embed Types GIF](../../assets/images/note-embed-type-demo.gif)
+
+## Scope
+
+- `full` - the entire note in the case of `![[note]]` or the entire section in the case of `![[note#section1]]`
+- `content` - everything excluding the title of the section. So the entire note minus the title for `![[note]]`, or the entire section minus the section header for `![[note#section1]]`
+
+## Style
+
+- `card` - outlines the embedded note with a border
+- `inline` - adds the note continuously as if the text were part of the calling note
+
+## Default Setting
+
+Foam expresses note display type as `<scope>-<style>`.
+
+By default, Foam configures note embedding to be `full-card`. That is, whenever the standard embedding syntax is used, `![[note]]`, the note will have `full` scope and `card` style display. This setting is stored under `foam.preview.embedNoteStyle` and can be modified.
+
+## Explicit Modifiers
+
+Prepend the wikilink with one of the scope or style keywords, or a combination of the two to explicitly modify a note embedding if you would like to override the default setting.
+
+For example, given your `foam.embedNoteStyle` is set to `content-card`, embedding a note with standard syntax `![[note-a]]` would show a bordered note without its title. Say, for a specific `note-b` you would like to display the title. You can simply use one of the above keywords to override your default setting like so: `full![[note-b]]`. In this case, `full` overrides the default `content` scope and because a style is not specified, it falls back to the default style setting, `card`. If you would like it to be inline, override that as well: `full-inline![[note-b]]`.

docs/user/features/including-notes.md

@@ -8,13 +8,16 @@ Including a note can be done by adding an `!` before a wikilink definition. For
 
 ## Custom styling
 
-Displaying the inclusion of notes allows for some custom styling, see [[custom-markdown-preview-styles]]
+To modify how an embedded note looks and the scope of its content, see [[built-in-note-embedding-types]]
+
+For more fine-grained custom styling, see [[custom-markdown-preview-styles]]
 
 ## Future possibilities
 
 Work on this feature is evolving and progressing. See the [[inclusion-of-notes]] proposal for the current discussion.
 
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[custom-markdown-preview-styles]: custom-markdown-preview-styles.md "Custom Markdown Preview Styles"
-[inclusion-of-notes]: ../../dev/proposals/inclusion-of-notes.md "Inclusion of notes Proposal "
-[//end]: # "Autogenerated link references"
+[//begin]: # 'Autogenerated link references for markdown compatibility'
+[built-in-note-embedding-types]: built-in-note-embedding-types.md 'Built-In Note Embedding Types'
+[custom-markdown-preview-styles]: custom-markdown-preview-styles.md 'Custom Markdown Preview Styles'
+[inclusion-of-notes]: ../../dev/proposals/inclusion-of-notes.md 'Inclusion of notes Proposal '
+[//end]: # 'Autogenerated link references'

docs/user/features/wikilinks.md

@@ -20,7 +20,10 @@ Remember, with `CTRL/CMD+click` on a wikilink you can navigate to the note, or c
 
 ## Support for sections
 
-Foam supports autocompletion, navigation, embedding and diagnostics for note sections. Just use the standard wiki syntax of `[[resource#Section Title]]`.
+Foam supports autocompletion, navigation, embedding and diagnostics for note sections. Just use the standard wiki syntax of `[[resource#Section Title]]`. 
+- If it's an external file, `[your link will need the filename](other-file.md#that-section-I-want-to-link-to)`, but
+- if it's an anchor within the same document, `[you just need an octothorpe and the section name](#that-section-above)`. 
+- Doesn't matter what heading-level the anchor is; whether you're linking to an `H1` like `# MEN WALK ON MOON` or an `H2` like `## Astronauts Land on Plain`, the link syntax uses a single octothorpe: `[Walk!](#men-walk-on-moon)` and `[Land!](#astronauts-land-on-plain-collect-rocks-plant-flag)`. Autocomplete is your friend here.
 
 ## Markdown compatibility
 

docs/user/getting-started/recommended-extensions.md

@@ -6,11 +6,11 @@ This list is subject to change.
 
 - [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) (alpha)
 - [Markdown All In One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
-- [Paste Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image)
+- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
 
 ## Extensions For Additional Features
 
-These extensions are not (yet?) defined in `.vscode/extensions.json`, but have been used by others and shown to play nice with Foam.
+These extensions are not defined in `.vscode/extensions.json`, but have been used by others and shown to play nice with Foam.
 
 - [Emojisense](https://marketplace.visualstudio.com/items?itemName=bierner.emojisense)
 - [Markdown Emoji](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-emoji) (adds `:smile:` syntax, works with emojisense to provide autocomplete for this syntax)

docs/user/recipes/add-images-to-notes.md

@@ -2,8 +2,12 @@
 
 This #recipe allows you to paste images on to your notes.
 
-You can directly link and paste images that are copied to the clipboard using either the [Paste
-Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image)
-extension, or the [Markdown Image](https://marketplace.visualstudio.com/items?itemName=hancel.markdown-image) extension.
+VScode (since
+[1.79](https://code.visualstudio.com/updates/v1_79#_copy-external-media-files-into-workspace-on-drop-or-paste-for-markdown))
+now has the ability to paste images from the clipboard, or drag-and-drop image
+files, directly into markdown documents. The file will be created in the
+workspace, and a link generated in Markdown format. 
 
-The former does not have MDX support (yet), the latter does.
+VSCode settings under `Markdown > Copy Files` and `Markdown > Editor > Drop` can
+be used to configure where the files get placed in your workspace, how they're
+named, how conflicts with existing files are handled, and more.

lerna.json

@@ -4,5 +4,5 @@
  ],
  "npmClient": "yarn",
  "useWorkspaces": true,
- "version": "0.25.2"
+ "version": "0.25.4"
 }

packages/foam-vscode/CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to the "foam-vscode" extension will be documented in this fi
 
 Check [Keep a Changelog](https://keepachangelog.com/) for recommendations on how to structure this file.
 
+## [0.25.4] - 2023-09-19
+
+Fixes and Improvements:
+
+- Added support for linking sections within same document (#1289)
+- Fixed note embedding bug (#1286 - thanks @badsketch)
+
+## [0.25.3] - 2023-09-07
+
+Fixes and Improvements:
+
+- Fixed incorrect handling of embedding of non-existing notes (#1283 - thanks @badsketch)
+- Introduced Note Embedding Sytanx (#1281 - thanks @badsketch)
+- Attachments are not considered when computing orphan notes (#1242)
+
 ## [0.25.2] - 2023-09-02
 
 Fixes and Improvements:

packages/foam-vscode/package.json

@@ -8,7 +8,7 @@
  "type": "git"
  },
  "homepage": "https://github.com/foambubble/foam",
- "version": "0.25.2",
+ "version": "0.25.4",
  "license": "MIT",
  "publisher": "foam",
  "engines": {
@@ -609,12 +609,6 @@
  ],
  "description": "Whether or not to navigate to the target daily note when a daily note snippet is selected."
  },
- "foam.preview.embedNoteInContainer": {
- "type": "boolean",
- "default": true,
- "description": "Wrap embedded notes in a container when displayed in preview panel",
- "deprecationMessage": "*DEPRECATED* use foam.preview.embedNoteType instead."
- },
  "foam.preview.embedNoteType": {
  "type": "string",
  "default": "full-card",

packages/foam-vscode/src/core/services/markdown-provider.test.ts

@@ -316,4 +316,40 @@ describe('Generation of markdown references', () => {
  '../dir3/page-c.md',
  ]);
  });
+
+ it('should generate links for embedded notes that are formatted properly', () => {
+ const workspace = createTestWorkspace();
+ const noteA = createNoteFromMarkdown(
+ 'Link to ![[page-b]] and [[page-c]]',
+ '/dir1/page-a.md'
+ );
+ workspace
+ .set(noteA)
+ .set(createNoteFromMarkdown('Content of note B', '/dir2/page-b.md'))
+ .set(createNoteFromMarkdown('Content of note C', '/dir3/page-c.md'));
+
+ const references = createMarkdownReferences(workspace, noteA.uri, true);
+ expect(references.map(r => [r.url, r.label])).toEqual([
+ ['../dir2/page-b.md', 'page-b'],
+ ['../dir3/page-c.md', 'page-c'],
+ ]);
+ });
+
+ it('should not generate links for placeholders', () => {
+ const workspace = createTestWorkspace();
+ const noteA = createNoteFromMarkdown(
+ 'Link to ![[page-b]] and [[page-c]] and [[does-not-exist]] and ![[does-not-exist-either]]',
+ '/dir1/page-a.md'
+ );
+ workspace
+ .set(noteA)
+ .set(createNoteFromMarkdown('Content of note B', '/dir2/page-b.md'))
+ .set(createNoteFromMarkdown('Content of note C', '/dir3/page-c.md'));
+
+ const references = createMarkdownReferences(workspace, noteA.uri, true);
+ expect(references.map(r => r.url)).toEqual([
+ '../dir2/page-b.md',
+ '../dir3/page-c.md',
+ ]);
+ });
 });

packages/foam-vscode/src/core/services/markdown-provider.ts

@@ -139,10 +139,12 @@ export function createMarkdownReferences(
 
  // [wikilink-text]: path/to/file.md "Page title"
  return {
- label:
- link.rawText.indexOf('[[') > -1
- ? link.rawText.substring(2, link.rawText.length - 2)
- : link.rawText,
+ // embedded looks like ![[note-a]]
+ // regular note looks like [[note-a]]
+ label: link.rawText.substring(
+ link.isEmbed ? 3 : 2,
+ link.rawText.length - 2
+ ),
  url: relativeUri.path,
  title: target.title,
  };