From a8a418824f9e40854f393cd692ba20fbfb3a8e67 Mon Sep 17 00:00:00 2001 From: Riccardo Ferretti Date: Sun, 21 Nov 2021 19:53:07 +0100 Subject: [PATCH] moved screenshots in foam-vscode package --- packages/foam-vscode/README.md | 26 +++++++-------- .../{ => assets}/icon/FOAM_ICON.png | Bin .../{ => assets}/icon/FOAM_ICON_256.png | Bin .../screenshots}/feature-backlinks-panel.gif | Bin .../screenshots}/feature-daily-note.gif | Bin .../feature-definition-references.gif | Bin .../feature-definitions-generation.gif | Bin .../feature-link-autocompletion.gif | Bin .../screenshots}/feature-navigation.gif | Bin .../screenshots}/feature-note-embed.gif | Bin .../feature-placeholder-orphan-panel.gif | Bin .../feature-preview-navigation.gif | Bin .../screenshots}/feature-show-graph.gif | Bin .../screenshots}/feature-syntax-highlight.png | Bin .../screenshots}/feature-tags-panel.gif | Bin .../assets/screenshots}/feature-templates.gif | Bin .../foam-features-dark-mode-demo.png | Bin packages/foam-vscode/package.json | 4 +-- readme.md | 31 ++++++++---------- 19 files changed, 29 insertions(+), 32 deletions(-) rename packages/foam-vscode/{ => assets}/icon/FOAM_ICON.png (100%) rename packages/foam-vscode/{ => assets}/icon/FOAM_ICON_256.png (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-backlinks-panel.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-daily-note.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-definition-references.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-definitions-generation.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-link-autocompletion.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-navigation.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-note-embed.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-placeholder-orphan-panel.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-preview-navigation.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-show-graph.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-syntax-highlight.png (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-tags-panel.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/feature-templates.gif (100%) rename {docs/assets/images => packages/foam-vscode/assets/screenshots}/foam-features-dark-mode-demo.png (100%) diff --git a/packages/foam-vscode/README.md b/packages/foam-vscode/README.md index c79e4c0a..da7876a2 100644 --- a/packages/foam-vscode/README.md +++ b/packages/foam-vscode/README.md @@ -19,36 +19,36 @@ Foam is also meant to be extensible, so you can integrate with its internals to See how your notes are connected via a [graph](https://foambubble.github.io/foam/features/graph-visualisation) with the `Foam: Show Graph` command. -![Graph Visualization](../../docs/assets/images/feature-show-graph.gif) +![Graph Visualization](./assets/screenshots/feature-show-graph.gif) ### Link Autocompletion Foam helps you create the connections between your notes, and your placeholders as well. -![Link Autocompletion](../../docs/assets/images/feature-link-autocompletion.gif) +![Link Autocompletion](./assets/screenshots/feature-link-autocompletion.gif) ### Link Preview and Navigation -![Link Preview and Navigation](../../docs/assets/images/feature-navigation.gif) +![Link Preview and Navigation](./assets/screenshots/feature-navigation.gif) ### Go to definition, Peek References See where a note is being referenced in your knowledge base. -![Go to Definition, Peek References](../../docs/assets/images/feature-definition-references.gif) +![Go to Definition, Peek References](./assets/screenshots/feature-definition-references.gif) ### Navigation in Preview Navigate your rendered notes in the VS Code preview panel. -![Navigation in Preview](../../docs/assets/images/feature-preview-navigation.gif) +![Navigation in Preview](./assets/screenshots/feature-preview-navigation.gif) ### Note embed Embed the content from other notes. -![Note Embed](../../docs/assets/images/feature-note-embed.gif) +![Note Embed](./assets/screenshots/feature-note-embed.gif) ### Link Alias @@ -58,21 +58,21 @@ Foam supports link aliasing, so you can have a `[[wikilink]]`, or a `[[wikilink| Use [custom templates](https://foambubble.github.io/foam/features/note-templates) to have avoid repetitve work on your notes. -![Templates](../../docs/assets/images/feature-templates.gif) +![Templates](./assets/screenshots/feature-templates.gif) ### Backlinks Panel Quickly check which notes are referencing the currently active note. See for each occurrence the context in which it lives, as well as a preview of the note. -![Backlinks Panel](../../docs/assets/images/feature-backlinks-panel.gif) +![Backlinks Panel](./assets/screenshots/feature-backlinks-panel.gif) ### Tag Explorer Panel Tag your notes and navigate them with the [Tag Explorer](https://foambubble.github.io/foam/features/tags). Foam also supports hierarchical tags. -![Tag Explorer Panel](../../docs/assets/images/feature-tags-panel.gif) +![Tag Explorer Panel](./assets/screenshots/feature-tags-panel.gif) ### Orphans and Placeholder Panels @@ -80,26 +80,26 @@ Orphans are note that have no inbound nor outbound links. Placeholders are dangling links, or notes without content. Keep them under control, and your knowledge base in better state, by using this panel. -![Orphans and Placeholder Panels](../../docs/assets/images/feature-placeholder-orphan-panel.gif) +![Orphans and Placeholder Panels](./assets/screenshots/feature-placeholder-orphan-panel.gif) ### Syntax highlight Foam highlights wikilinks and placeholder differently, to help you visualize your knowledge base. -![Syntax Highlight](../../docs/assets/images/feature-syntax-highlight.png) +![Syntax Highlight](./assets/screenshots/feature-syntax-highlight.png) ### Daily note Create a journal with [daily notes](https://foambubble.github.io/foam/features/daily-notes). -![Daily Note](../../docs/assets/images/feature-daily-note.gif) +![Daily Note](./assets/screenshots/feature-daily-note.gif) ### Generate references for your wikilinks Create markdown [references](https://foambubble.github.io/foam/features/link-reference-definitions) for `[[wikilinks]]`, to use your notes in a non-Foam workspace. With references you can also make your notes navigable both in GitHub UI as well as GitHub Pages. -![Generate references](../../docs/assets/images/feature-definitions-generation.gif) +![Generate references](./assets/screenshots/feature-definitions-generation.gif) ### Commands diff --git a/packages/foam-vscode/icon/FOAM_ICON.png b/packages/foam-vscode/assets/icon/FOAM_ICON.png similarity index 100% rename from packages/foam-vscode/icon/FOAM_ICON.png rename to packages/foam-vscode/assets/icon/FOAM_ICON.png diff --git a/packages/foam-vscode/icon/FOAM_ICON_256.png b/packages/foam-vscode/assets/icon/FOAM_ICON_256.png similarity index 100% rename from packages/foam-vscode/icon/FOAM_ICON_256.png rename to packages/foam-vscode/assets/icon/FOAM_ICON_256.png diff --git a/docs/assets/images/feature-backlinks-panel.gif b/packages/foam-vscode/assets/screenshots/feature-backlinks-panel.gif similarity index 100% rename from docs/assets/images/feature-backlinks-panel.gif rename to packages/foam-vscode/assets/screenshots/feature-backlinks-panel.gif diff --git a/docs/assets/images/feature-daily-note.gif b/packages/foam-vscode/assets/screenshots/feature-daily-note.gif similarity index 100% rename from docs/assets/images/feature-daily-note.gif rename to packages/foam-vscode/assets/screenshots/feature-daily-note.gif diff --git a/docs/assets/images/feature-definition-references.gif b/packages/foam-vscode/assets/screenshots/feature-definition-references.gif similarity index 100% rename from docs/assets/images/feature-definition-references.gif rename to packages/foam-vscode/assets/screenshots/feature-definition-references.gif diff --git a/docs/assets/images/feature-definitions-generation.gif b/packages/foam-vscode/assets/screenshots/feature-definitions-generation.gif similarity index 100% rename from docs/assets/images/feature-definitions-generation.gif rename to packages/foam-vscode/assets/screenshots/feature-definitions-generation.gif diff --git a/docs/assets/images/feature-link-autocompletion.gif b/packages/foam-vscode/assets/screenshots/feature-link-autocompletion.gif similarity index 100% rename from docs/assets/images/feature-link-autocompletion.gif rename to packages/foam-vscode/assets/screenshots/feature-link-autocompletion.gif diff --git a/docs/assets/images/feature-navigation.gif b/packages/foam-vscode/assets/screenshots/feature-navigation.gif similarity index 100% rename from docs/assets/images/feature-navigation.gif rename to packages/foam-vscode/assets/screenshots/feature-navigation.gif diff --git a/docs/assets/images/feature-note-embed.gif b/packages/foam-vscode/assets/screenshots/feature-note-embed.gif similarity index 100% rename from docs/assets/images/feature-note-embed.gif rename to packages/foam-vscode/assets/screenshots/feature-note-embed.gif diff --git a/docs/assets/images/feature-placeholder-orphan-panel.gif b/packages/foam-vscode/assets/screenshots/feature-placeholder-orphan-panel.gif similarity index 100% rename from docs/assets/images/feature-placeholder-orphan-panel.gif rename to packages/foam-vscode/assets/screenshots/feature-placeholder-orphan-panel.gif diff --git a/docs/assets/images/feature-preview-navigation.gif b/packages/foam-vscode/assets/screenshots/feature-preview-navigation.gif similarity index 100% rename from docs/assets/images/feature-preview-navigation.gif rename to packages/foam-vscode/assets/screenshots/feature-preview-navigation.gif diff --git a/docs/assets/images/feature-show-graph.gif b/packages/foam-vscode/assets/screenshots/feature-show-graph.gif similarity index 100% rename from docs/assets/images/feature-show-graph.gif rename to packages/foam-vscode/assets/screenshots/feature-show-graph.gif diff --git a/docs/assets/images/feature-syntax-highlight.png b/packages/foam-vscode/assets/screenshots/feature-syntax-highlight.png similarity index 100% rename from docs/assets/images/feature-syntax-highlight.png rename to packages/foam-vscode/assets/screenshots/feature-syntax-highlight.png diff --git a/docs/assets/images/feature-tags-panel.gif b/packages/foam-vscode/assets/screenshots/feature-tags-panel.gif similarity index 100% rename from docs/assets/images/feature-tags-panel.gif rename to packages/foam-vscode/assets/screenshots/feature-tags-panel.gif diff --git a/docs/assets/images/feature-templates.gif b/packages/foam-vscode/assets/screenshots/feature-templates.gif similarity index 100% rename from docs/assets/images/feature-templates.gif rename to packages/foam-vscode/assets/screenshots/feature-templates.gif diff --git a/docs/assets/images/foam-features-dark-mode-demo.png b/packages/foam-vscode/assets/screenshots/foam-features-dark-mode-demo.png similarity index 100% rename from docs/assets/images/foam-features-dark-mode-demo.png rename to packages/foam-vscode/assets/screenshots/foam-features-dark-mode-demo.png diff --git a/packages/foam-vscode/package.json b/packages/foam-vscode/package.json index 70b871ae..c90fa08b 100644 --- a/packages/foam-vscode/package.json +++ b/packages/foam-vscode/package.json @@ -14,7 +14,7 @@ "engines": { "vscode": "^1.47.1" }, - "icon": "icon/FOAM_ICON_256.png", + "icon": "assets/icon/FOAM_ICON_256.png", "categories": [ "Other" ], @@ -423,4 +423,4 @@ "unist-util-visit": "^2.0.2", "yaml": "^1.10.0" } -} +} \ No newline at end of file diff --git a/readme.md b/readme.md index ffff56a1..dfaa1e21 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ - + # Foam @@ -22,36 +22,36 @@ You can use **Foam** for organising your research, keeping re-discoverable notes See how your notes are connected via a [graph](https://foambubble.github.io/foam/features/graph-visualisation) with the `Foam: Show Graph` command. -![Graph Visualization](./docs/assets/images/feature-show-graph.gif) +![Graph Visualization](./packages/foam-vscode/assets/screenshots/feature-show-graph.gif) ### Link Autocompletion Foam helps you create the connections between your notes, and your placeholders as well. -![Link Autocompletion](./docs/assets/images/feature-link-autocompletion.gif) +![Link Autocompletion](./packages/foam-vscode/assets/screenshots/feature-link-autocompletion.gif) ### Link Preview and Navigation -![Link Preview and Navigation](./docs/assets/images/feature-navigation.gif) +![Link Preview and Navigation](./packages/foam-vscode/assets/screenshots/feature-navigation.gif) ### Go to definition, Peek References See where a note is being referenced in your knowledge base. -![Go to Definition, Peek References](./docs/assets/images/feature-definition-references.gif) +![Go to Definition, Peek References](./packages/foam-vscode/assets/screenshots/feature-definition-references.gif) ### Navigation in Preview Navigate your rendered notes in the VS Code preview panel. -![Navigation in Preview](./docs/assets/images/feature-preview-navigation.gif) +![Navigation in Preview](./packages/foam-vscode/assets/screenshots/feature-preview-navigation.gif) ### Note embed Embed the content from other notes. -![Note Embed](./docs/assets/images/feature-note-embed.gif) +![Note Embed](./packages/foam-vscode/assets/screenshots/feature-note-embed.gif) ### Link Alias @@ -61,21 +61,21 @@ Foam supports link aliasing, so you can have a `[[wikilink]]`, or a `[[wikilink| Use [custom templates](https://foambubble.github.io/foam/features/note-templates) to have avoid repetitve work on your notes. -![Templates](./docs/assets/images/feature-templates.gif) +![Templates](./packages/foam-vscode/assets/screenshots/feature-templates.gif) ### Backlinks Panel Quickly check which notes are referencing the currently active note. See for each occurrence the context in which it lives, as well as a preview of the note. -![Backlinks Panel](./docs/assets/images/feature-backlinks-panel.gif) +![Backlinks Panel](./packages/foam-vscode/assets/screenshots/feature-backlinks-panel.gif) ### Tag Explorer Panel Tag your notes and navigate them with the [Tag Explorer](https://foambubble.github.io/foam/features/tags). Foam also supports hierarchical tags. -![Tag Explorer Panel](./docs/assets/images/feature-tags-panel.gif) +![Tag Explorer Panel](./packages/foam-vscode/assets/screenshots/feature-tags-panel.gif) ### Orphans and Placeholder Panels @@ -83,26 +83,26 @@ Orphans are note that have no inbound nor outbound links. Placeholders are dangling links, or notes without content. Keep them under control, and your knowledge base in better state, by using this panel. -![Orphans and Placeholder Panels](./docs/assets/images/feature-placeholder-orphan-panel.gif) +![Orphans and Placeholder Panels](./packages/foam-vscode/assets/screenshots/feature-placeholder-orphan-panel.gif) ### Syntax highlight Foam highlights wikilinks and placeholder differently, to help you visualize your knowledge base. -![Syntax Highlight](./docs/assets/images/feature-syntax-highlight.png) +![Syntax Highlight](./packages/foam-vscode/assets/screenshots/feature-syntax-highlight.png) ### Daily note Create a journal with [daily notes](https://foambubble.github.io/foam/features/daily-notes). -![Daily Note](./docs/assets/images/feature-daily-note.gif) +![Daily Note](./packages/foam-vscode/assets/screenshots/feature-daily-note.gif) ### Generate references for your wikilinks Create markdown [references](https://foambubble.github.io/foam/features/link-reference-definitions) for `[[wikilinks]]`, to use your notes in a non-Foam workspace. With references you can also make your notes navigable both in GitHub UI as well as GitHub Pages. -![Generate references](./docs/assets/images/feature-definitions-generation.gif) +![Generate references](./packages/foam-vscode/assets/screenshots/feature-definitions-generation.gif) ### Commands @@ -166,9 +166,6 @@ You can also browse the [docs folder](https://github.com/foambubble/foam/tree/ma Foam is licensed under the [MIT license](LICENSE). [//begin]: # "Autogenerated link references for markdown compatibility" -[wikilinks]: docs/wikilinks.md "Wikilinks" -[Getting started]: docs/index.md "Getting started" -[Graph Visualisation]: docs/features/graph-visualisation.md "Graph Visualisation" [Backlinking]: docs/features/backlinking.md "Backlinking" [//end]: # "Autogenerated link references"