commit ac5401aa071170292476a46d9c8cc9b27ed13eb2 Author: makary Date: Tue Nov 7 00:46:09 2023 +0100 Initial commit diff --git a/.foam/templates/your-first-template.md b/.foam/templates/your-first-template.md new file mode 100644 index 0000000..5f85612 --- /dev/null +++ b/.foam/templates/your-first-template.md @@ -0,0 +1,25 @@ +# Foam Note Templates + +Foam includes note templates! +This allows you to easily create notes that have similar structure without having to use copy/paste :) + +Templates support the [VS Code's Snippet Syntax](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_snippet-syntax), which means you can: +- add variables to the newly created note +- add tabstop to automatically navigate to the key parts of the note, just like a form +Below you can see an example showing a todo list and a timestamp. + +## Todo List + +1. ${1:First tabstop} +2. ${2:A second tabstop} +3. ${3:A third tabstop} + +Note Created: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} + +--- + +Try out the above example by running the `Foam: Create New Note From Template` command and selecting the `your-first-template` template. Notice what happens when your new note is created! + +To remove this template, simply delete the `.foam/templates/your-first-template.md` file. + +Enjoy! diff --git a/.vscode/custom-tag-style.css b/.vscode/custom-tag-style.css new file mode 100644 index 0000000..6c604cd --- /dev/null +++ b/.vscode/custom-tag-style.css @@ -0,0 +1,4 @@ +.foam-tag{ + color:#ffffff; + background-color: #000000; +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..4ce4c9b --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,17 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + // Foam's own extension + "foam.foam-vscode", + + // Tons of markdown goodies (lists, tables of content, so much more) + "yzhang.markdown-all-in-one", + + // Prettier for auto formatting code + "esbenp.prettier-vscode", + + // Understated grayscale theme (light and dark variants) + "philipbe.theme-gray-matter" + ] +} diff --git a/.vscode/keybindings.json b/.vscode/keybindings.json new file mode 100644 index 0000000..cf9785f --- /dev/null +++ b/.vscode/keybindings.json @@ -0,0 +1,8 @@ +// This file does not get automatically applied +// @TODO: Make it work or document how to copy to user keybindings +[ + { + "key": "cmd+shift+n", + "command": "foam-vscode.create-note" + } +] diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..7a19f9f --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,22 @@ +{ + "files.autoSave": "onFocusChange", + "editor.minimap.enabled": false, + "editor.wrappingIndent": "indent", + "editor.overviewRulerBorder": false, + "editor.lineHeight": 24, + "foam.edit.linkReferenceDefinitions": "withExtensions", + "[markdown]": { + "editor.quickSuggestions": { + "other": true, + "comments": false, + "strings": false + } + }, + "git.enableSmartCommit": true, + "git.postCommitCommand": "sync", + "files.exclude": { + "_site/**": true + }, + "files.insertFinalNewline": true, + "markdown.styles": [".vscode/custom-tag-style.css"] +} diff --git a/_layouts/home.html b/_layouts/home.html new file mode 100644 index 0000000..33d9afb --- /dev/null +++ b/_layouts/home.html @@ -0,0 +1,18 @@ +--- +layout: default +--- + +{{ content }} + + diff --git a/_layouts/page.html b/_layouts/page.html new file mode 100644 index 0000000..33d9afb --- /dev/null +++ b/_layouts/page.html @@ -0,0 +1,18 @@ +--- +layout: default +--- + +{{ content }} + + diff --git a/assets/css/style.scss b/assets/css/style.scss new file mode 100644 index 0000000..0a192df --- /dev/null +++ b/assets/css/style.scss @@ -0,0 +1,74 @@ +--- +--- + +@import "{{ site.theme }}"; + +a { + color: #3300ff; +} + +.markdown-body { + max-width: 800px; + font-size: 16px; +} + +.markdown-body p { + font-size: 16px; + line-height: 1.9em; + margin-bottom: 1.2em; +} + +.markdown-body li { + line-height: 1.9em; +} + +input.task-list-item-checkbox { + margin-right: 4px; +} + +img[src*="demo"] { + border: 1px #eee solid; + -webkit-box-shadow: 4px 4px 16px 0px rgba(50, 50, 50, 0.1); + -moz-box-shadow: 4px 4px 16px 0px rgba(50, 50, 50, 0.1); + box-shadow: 4px 4px 16px 0px rgba(50, 50, 50, 0.1); +} + +@media only screen and (min-width: 1170px) { + img[src*="demo"] { + max-width: 130%; + margin-left: -15%; + margin-top: 20px; + margin-bottom: 20px; + } +} + +h1, +h2, +h3, +h4, +h5, +blockquote { + font-family: Constantia, "Lucida Bright", Lucidabright, "Lucida Serif", Lucida, + "DejaVu Serif", "Bitstream Vera Serif", "Liberation Serif", Georgia, serif; +} + +.wikilink:before { + content: "[["; + opacity: 0.5; +} + +.wikilink:after { + content: "]]"; + opacity: 0.5; +} + +.github-only { + display: none; +} + +.announcement { + background: #ede7ff; + padding: 4px 16px; + color: black; + border-radius: 4px; +} diff --git a/assets/images/azure-devops-wiki-demo.png b/assets/images/azure-devops-wiki-demo.png new file mode 100644 index 0000000..72750fc Binary files /dev/null and b/assets/images/azure-devops-wiki-demo.png differ diff --git a/assets/images/create-new-note-from-template.gif b/assets/images/create-new-note-from-template.gif new file mode 100644 index 0000000..d16b6de Binary files /dev/null and b/assets/images/create-new-note-from-template.gif differ diff --git a/assets/images/create-new-template.gif b/assets/images/create-new-template.gif new file mode 100644 index 0000000..76f32c9 Binary files /dev/null and b/assets/images/create-new-template.gif differ diff --git a/assets/images/custom-snippet.gif b/assets/images/custom-snippet.gif new file mode 100644 index 0000000..73a5fd3 Binary files /dev/null and b/assets/images/custom-snippet.gif differ diff --git a/assets/images/custom-tag-style.png b/assets/images/custom-tag-style.png new file mode 100644 index 0000000..e17846e Binary files /dev/null and b/assets/images/custom-tag-style.png differ diff --git a/assets/images/daily-note.gif b/assets/images/daily-note.gif new file mode 100644 index 0000000..3c63fca Binary files /dev/null and b/assets/images/daily-note.gif differ diff --git a/assets/images/demo-backlinks-explorer.gif b/assets/images/demo-backlinks-explorer.gif new file mode 100644 index 0000000..c544e08 Binary files /dev/null and b/assets/images/demo-backlinks-explorer.gif differ diff --git a/assets/images/diagram-drawio-demo.drawio.svg b/assets/images/diagram-drawio-demo.drawio.svg new file mode 100644 index 0000000..ce8ca68 --- /dev/null +++ b/assets/images/diagram-drawio-demo.drawio.svg @@ -0,0 +1,68 @@ + + + + + + + + + + + +
+
+
+ 1 +
+
+
+ + + 1 + + + + + + + +
+
+
+ 2 +
+
+
+ + + 2 + + + + + + + +
+
+
+ 3 +
+
+
+ + + 3 + + + + + + + + + Viewer does not support full SVG 1.1 + + + + diff --git a/assets/images/foam-janitor-demo.gif b/assets/images/foam-janitor-demo.gif new file mode 100644 index 0000000..5db7ce5 Binary files /dev/null and b/assets/images/foam-janitor-demo.gif differ diff --git a/assets/images/foam-log.png b/assets/images/foam-log.png new file mode 100644 index 0000000..071fddc Binary files /dev/null and b/assets/images/foam-log.png differ diff --git a/assets/images/foam-navigation-demo.gif b/assets/images/foam-navigation-demo.gif new file mode 100644 index 0000000..908fc6c Binary files /dev/null and b/assets/images/foam-navigation-demo.gif differ diff --git a/assets/images/graph-filter.gif b/assets/images/graph-filter.gif new file mode 100755 index 0000000..29ed7ed Binary files /dev/null and b/assets/images/graph-filter.gif differ diff --git a/assets/images/graph-style.gif b/assets/images/graph-style.gif new file mode 100644 index 0000000..651ffbd Binary files /dev/null and b/assets/images/graph-style.gif differ diff --git a/assets/images/markdown-snippets.gif b/assets/images/markdown-snippets.gif new file mode 100644 index 0000000..12b61e2 Binary files /dev/null and b/assets/images/markdown-snippets.gif differ diff --git a/assets/images/md-notes-autocomplete-no-extension.png b/assets/images/md-notes-autocomplete-no-extension.png new file mode 100644 index 0000000..ab7d82a Binary files /dev/null and b/assets/images/md-notes-autocomplete-no-extension.png differ diff --git a/assets/images/md-notes-autocomplete-with-extension.png b/assets/images/md-notes-autocomplete-with-extension.png new file mode 100644 index 0000000..ba7395d Binary files /dev/null and b/assets/images/md-notes-autocomplete-with-extension.png differ diff --git a/assets/images/migrating-one-note.png b/assets/images/migrating-one-note.png new file mode 100644 index 0000000..140d255 Binary files /dev/null and b/assets/images/migrating-one-note.png differ diff --git a/assets/images/note-embed-type-demo.gif b/assets/images/note-embed-type-demo.gif new file mode 100644 index 0000000..759a456 Binary files /dev/null and b/assets/images/note-embed-type-demo.gif differ diff --git a/assets/images/prettify-links-demo.gif b/assets/images/prettify-links-demo.gif new file mode 100644 index 0000000..1d38d3d Binary files /dev/null and b/assets/images/prettify-links-demo.gif differ diff --git a/assets/images/preview-image-in-glutter.png b/assets/images/preview-image-in-glutter.png new file mode 100644 index 0000000..571ccb4 Binary files /dev/null and b/assets/images/preview-image-in-glutter.png differ diff --git a/assets/images/preview-image-on-hover.png b/assets/images/preview-image-on-hover.png new file mode 100644 index 0000000..1fcd691 Binary files /dev/null and b/assets/images/preview-image-on-hover.png differ diff --git a/assets/images/readme-demo.gif b/assets/images/readme-demo.gif new file mode 100644 index 0000000..1f4678a Binary files /dev/null and b/assets/images/readme-demo.gif differ diff --git a/assets/images/snippets.gif b/assets/images/snippets.gif new file mode 100644 index 0000000..2866a7c Binary files /dev/null and b/assets/images/snippets.gif differ diff --git a/assets/images/style-node-by-type.png b/assets/images/style-node-by-type.png new file mode 100644 index 0000000..21aa8f8 Binary files /dev/null and b/assets/images/style-node-by-type.png differ diff --git a/assets/images/template-picker-annotated.png b/assets/images/template-picker-annotated.png new file mode 100644 index 0000000..5cf7ce6 Binary files /dev/null and b/assets/images/template-picker-annotated.png differ diff --git a/assets/images/vercel-detect-preset.png b/assets/images/vercel-detect-preset.png new file mode 100644 index 0000000..932b30d Binary files /dev/null and b/assets/images/vercel-detect-preset.png differ diff --git a/attachments/foam-icon.png b/attachments/foam-icon.png new file mode 100644 index 0000000..03c8d50 Binary files /dev/null and b/attachments/foam-icon.png differ diff --git a/docs/features/backlinking.md b/docs/features/backlinking.md new file mode 100644 index 0000000..7f34a55 --- /dev/null +++ b/docs/features/backlinking.md @@ -0,0 +1,10 @@ +# Backlinking + +When using [[wikilinks]], you can find all notes that link to a specific note in the **Connections Explorer** + +- Run `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "connections" and run the **Explorer: Focus on Connections** view. +- Keep this pane always visible to discover relationships between your thoughts +- You can drag the connections panel to a different section in VS Code if you prefer. See: [[make-backlinks-more-prominent]] +- You can filter the connections to see just backlinks, forward links, or all connections +- Finding backlinks in published Foam workspaces via [[materialized-backlinks]] is on the [[roadmap]] but not yet implemented. + diff --git a/docs/features/built-in-note-embedding-types.md b/docs/features/built-in-note-embedding-types.md new file mode 100644 index 0000000..64cd6e5 --- /dev/null +++ b/docs/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 `-