diff --git a/docs/_layouts/foam.html b/docs/_layouts/foam.html index a70783cd..0e0ac1ae 100644 --- a/docs/_layouts/foam.html +++ b/docs/_layouts/foam.html @@ -19,21 +19,21 @@ window.addEventListener('DOMContentLoaded', (event) => { document .querySelectorAll(".markdown-body a[title]:not([href^=http])") .forEach((a) => { - // filter to only wiki-links + // filter to only wikilinks var prev = a.previousSibling; var next = a.nextSibling; if ( - prev instanceof Text && prev.textContent.endsWith('[') && + prev instanceof Text && prev.textContent.endsWith('[') && next instanceof Text && next.textContent.startsWith(']') ) { - + // remove surrounding brackets prev.textContent = prev.textContent.slice(0, -1); next.textContent = next.textContent.slice(1); // add CSS list for styling a.classList.add('wikilink'); - + // replace page-link with "Page Title"... a.innerText = a.title; diff --git a/docs/dev/foam-core.md b/docs/dev/foam-core.md index 6b1ed89b..26d73a33 100644 --- a/docs/dev/foam-core.md +++ b/docs/dev/foam-core.md @@ -17,7 +17,7 @@ `foam-core`'s primary responsibility is to build an API on top of a workspace of markdown files, which allows us to: - Treat files as a graph, based on links - - Can be either [[wiki-links]] or relative `[markdown](links.md)` style + - Can be either [[wikilinks]] or relative `[markdown](links.md)` style - We need to know about the edges (connections) as well as nodes - What link points to what other file, etc. - Needs to have the exact link text, e.g. even if `[[some-page]]` or `[[some-page.md]]` or `[[Some Page]]` point to the same document (`./some-page.md`), we need to know which format was used, so [[link-reference-definitions]] can be generated correctly @@ -61,7 +61,7 @@ Here are some example use cases that the core should support. They don't need to - Adding and editing page content - [[materialized-backlinks]] - - [[link-reference-definitions]] for [[wiki-links]] + - [[link-reference-definitions]] for [[wikilinks]] - [Frontmatter](https://jekyllrb.com/docs/front-matter/) - Finding all documents with `#tag` - Finding all documents with instances of `[[link]]` @@ -99,7 +99,7 @@ Useful for knowing what needs to be supported. See [[feature-comparison]]. [workspace-janitor]: ../features/workspace-janitor.md "Janitor" [cli]: ../features/cli.md "Command Line Interface" [build-vs-assemble]: build-vs-assemble.md "Build vs Assemble" -[wiki-links]: ../wiki-links.md "Wiki Links" +[wikilinks]: ../wikilinks.md "Wikilinks" [link-reference-definitions]: ../features/link-reference-definitions.md "Link Reference Definitions" [materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)" [todo]: todo.md "Todo" diff --git a/docs/dev/foam-file-format.md b/docs/dev/foam-file-format.md index b3ad6f35..a2ac8c31 100644 --- a/docs/dev/foam-file-format.md +++ b/docs/dev/foam-file-format.md @@ -1,16 +1,16 @@ # Foam File Format -This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for mediawiki-style `[[wiki-links]]`. +This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for MediaWiki-style `[[wikilinks]]`. -Here are a few specific constraints, mainly because our tooling is a bit fragmented. Most of these should be eventually lifted, and our requirement should just be "Markdown with `[[wiki-links]]`: +Here are a few specific constraints, mainly because our tooling is a bit fragmented. Most of these should be eventually lifted, and our requirement should just be "Markdown with `[[wikilinks]]`: - **The first top level `# Heading` will be used as title for the note.** - If not available, we will use the file name - **File name should have extension `.md`** - This is a temporary limitation and will be lifted in future versions. - At least `.mdx` will be supported, but ideally we'll support any file that you can map to `Markdown` language mode in VS Code -- **In addition to normal Markdown Links syntax you can use `[[media-wiki]]` links.** See [[wiki-links]] for more details. +- **In addition to normal Markdown Links syntax you can use `[[MediaWiki]]` links.** See [[wikilinks]] for more details. [//begin]: # "Autogenerated link references for markdown compatibility" -[wiki-links]: ../wiki-links.md "Wiki Links" +[wikilinks]: ../wikilinks.md "Wikilinks" [//end]: # "Autogenerated link references" diff --git a/docs/dev/link-reference-definition-improvements.md b/docs/dev/link-reference-definition-improvements.md index 67e28551..0d403cd8 100644 --- a/docs/dev/link-reference-definition-improvements.md +++ b/docs/dev/link-reference-definition-improvements.md @@ -4,13 +4,13 @@ ### File-by-file Insertion -For the time being, if you want to get [[wiki-links]] into all files within the workspace, you'll need to generate the link reference definitions yourself file-by-file (with the assistance of Foam). +For the time being, if you want to get [[wikilinks]] into all files within the workspace, you'll need to generate the link reference definitions yourself file-by-file (with the assistance of Foam). ### Wikilinks don't work on GitHub > **TL;DR;** [workaround](#workaround) in the end of the chapter. -If you click any of the wiki-links on GitHub web UI (such as the `README.md` of a project), you'll notice that the links break with a 404 error. +If you click any of the wikilinks on GitHub web UI (such as the `README.md` of a project), you'll notice that the links break with a 404 error. At the time of writing (June 28 2020) this is a known, but unsolved error. To understand why this is the case, we need to understand what we are trading off. @@ -59,7 +59,7 @@ Problem space in essence: - may clutter the search results - During build-time (when converting markdown to html for publishing purposes) - link reference definitions are needed, if the files are published via such tools (or to such platforms) that don't understand wikilinks - - link reference definitions might have to be in different formats depending on the publish target (e.g. Github pages vs Github UI) + - link reference definitions might have to be in different formats depending on the publish target (e.g. GitHub pages vs GitHub UI) The potential solution: @@ -122,8 +122,8 @@ The potential solution: ``` - - With Foam repo, just use edit-time link reference definitions with '.md' extension - this makes the links work in the Github UI - - Have publish target defined for Github pages, that doesn't use '.md' extension, but still has the link reference definitions. Generate the output into gh-pages branch (or separate repo) with automation. + - With Foam repo, just use edit-time link reference definitions with '.md' extension - this makes the links work in the GitHub UI + - Have publish target defined for GitHub pages, that doesn't use '.md' extension, but still has the link reference definitions. Generate the output into gh-pages branch (or separate repo) with automation. - This naturally requires first removing the existing link reference definitions during the build - Other - To clean up the search results, remove link reference definition section guards (assuming that these are not defined by the markdown spec). Use unifiedjs parse trees to identify if there's missing (or surplus) definitions (check if they are identified properly by the library), and just add the needed definitions to the bottom of the file (without guards) AND remove them if they are not needed (anywhere from the file). @@ -137,7 +137,7 @@ UI-wise, the publish targets could be picked in some similar fashion as the run/ - [tracking issue on GitHub](https://github.com/foambubble/foam/issues/16) [//begin]: # "Autogenerated link references for markdown compatibility" -[wiki-links]: ../wiki-links.md "Wiki Links" +[wikilinks]: ../wikilinks.md "Wikilinks" [link-reference-definitions]: ../features/link-reference-definitions.md "Link Reference Definitions" [backlinking]: ../features/backlinking.md "Backlinking" [//end]: # "Autogenerated link references" diff --git a/docs/dev/roadmap.md b/docs/dev/roadmap.md index 2ecac777..c1156f5e 100644 --- a/docs/dev/roadmap.md +++ b/docs/dev/roadmap.md @@ -25,7 +25,7 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu - [[improve-default-workspace-settings]] - Discussion: [foam#270](https://github.com/foambubble/foam/issues/270) - Improve [[git-integration]] -- Fix [[wiki-links]] compatibility issues +- Fix [[wikilinks]] compatibility issues - Simplify [[foam-file-format]] ### Core features @@ -87,7 +87,7 @@ The community is working on a number of automated scripts to help you migrate to [recipes]: ../recipes/recipes.md "Recipes" [contribution-guide]: ../contribution-guide.md "Contribution Guide" [git-integration]: ../features/git-integration.md "Git Integration" -[wiki-links]: ../wiki-links.md "Wiki Links" +[wikilinks]: ../wikilinks.md "Wikilinks" [foam-file-format]: foam-file-format.md "Foam File Format" [unlinked-references]: unlinked-references.md "Unlinked references (stub)" [make-backlinks-more-prominent]: ../recipes/make-backlinks-more-prominent.md "Make Backlinks More Prominent" diff --git a/docs/features/backlinking.md b/docs/features/backlinking.md index 7f3c0e00..f9398fa6 100644 --- a/docs/features/backlinking.md +++ b/docs/features/backlinking.md @@ -1,6 +1,6 @@ # Backlinking -When using [[wiki-links]], you can find all notes that link to a specific note in the [VS Code Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) **Backlinks Explorer** +When using [[wikilinks]], you can find all notes that link to a specific note in the [VS Code Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) **Backlinks Explorer** - Run `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "backlinks" and run the **Explorer: Focus on Backlinks** view. - Keep this pane always visible to discover relationships between your thoughts @@ -8,7 +8,7 @@ When using [[wiki-links]], you can find all notes that link to a specific note i - Finding backlinks in published Foam workspaces via [[materialized-backlinks]] is on the [[roadmap]] but not yet implemented. [//begin]: # "Autogenerated link references for markdown compatibility" -[wiki-links]: ../wiki-links.md "Wiki Links" +[wikilinks]: ../wikilinks.md "Wikilinks" [make-backlinks-more-prominent]: ../recipes/make-backlinks-more-prominent.md "Make Backlinks More Prominent" [materialized-backlinks]: ../dev/materialized-backlinks.md "Materialized Backlinks (stub)" [roadmap]: ../dev/roadmap.md "Roadmap" diff --git a/docs/features/creating-new-notes.md b/docs/features/creating-new-notes.md index a2130493..0a67c1df 100644 --- a/docs/features/creating-new-notes.md +++ b/docs/features/creating-new-notes.md @@ -1,6 +1,6 @@ # Creating New Notes -- Write out a new `[[wiki-link]]` and `Cmd` + `Click` to create a new file and enter it. +- Write out a new `[[wikilink]]` and `Cmd` + `Click` to create a new file and enter it. - For keyboard navigation, use the 'Follow Definition' key `F12` (or [remap key binding](https://code.visualstudio.com/docs/getstarted/keybindings) to something more ergonomic) - `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), execute `Foam: Create New Note` and enter a **Title Case Name** to create `Title Case Name.md` - Add a keyboard binding to make creating new notes easier. diff --git a/docs/features/link-reference-definitions.md b/docs/features/link-reference-definitions.md index a54d95d7..4654d396 100644 --- a/docs/features/link-reference-definitions.md +++ b/docs/features/link-reference-definitions.md @@ -2,22 +2,22 @@ ## Introduction -When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension will automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wiki-links]]`. +When you use `[[wikilinks]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension will automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wikilinks]]`. ## Example The following example: ```md - - [[wiki-links]] + - [[wikilinks]] - [[github-pages]] ``` ...generates the following link reference definitions to the bottom of the file: ```md - [wiki-links]: wiki-links "Wiki Links" - [github-pages]: github-pages "Github Pages" + [wikilinks]: wikilinks "Wikilinks" + [github-pages]: github-pages "GitHub Pages" ``` You can open the [raw markdown](https://foambubble.github.io/foam/features/link-reference-definitions.md) to see them at the bottom of this file @@ -26,7 +26,7 @@ You can open the [raw markdown](https://foambubble.github.io/foam/features/link- The three components of a link reference definition are `[link-label]: link-target "Link Title"` -- **link label:** The link text to match in the surrounding markdown document. This matches the inner bracket of the double-bracketed `[[wiki-link]]` notation +- **link label:** The link text to match in the surrounding markdown document. This matches the inner bracket of the double-bracketed `[[wikilink]]` notation - **link destination** The target of the matched link - By default we generate links without extension. This can be overridden, see [Configuration](#configuration) below - **"Link Title"** Optional title for link (The Foam template has a snippet of JavaScript to replace this on the website at runtime) diff --git a/docs/frequently-asked-questions.md b/docs/frequently-asked-questions.md index 30d7eb3c..166423e5 100644 --- a/docs/frequently-asked-questions.md +++ b/docs/frequently-asked-questions.md @@ -10,7 +10,7 @@ - Ensure that you have all the [[recommended-extensions]] installed in Visual Studio Code - Reload Visual Studio Code by running `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "reload" and run the **Developer: Reload Window** command to for the updated extensions take effect -- Check the formatting rules for links on [[foam-file-format]], [[wiki-links]] and [[link-formatting-and-autocompletion]] +- Check the formatting rules for links on [[foam-file-format]], [[wikilinks]] and [[link-formatting-and-autocompletion]] ## I don't want Foam enabled for all my workspaces Any extension you install in Visual Studio Code is enabled by default. Give the philosophy of Foam it works out of the box without doing any configuration upfront. In case you want to disable Foam for a specific workspace, or disable Foam by default and enable it for specific workspaces, it is advised to follow the best practices as [documented by Visual Studio Code](https://code.visualstudio.com/docs/editor/extension-marketplace#_manage-extensions) @@ -18,5 +18,5 @@ Any extension you install in Visual Studio Code is enabled by default. Give the [//begin]: # "Autogenerated link references for markdown compatibility" [recommended-extensions]: recommended-extensions.md "Recommended Extensions" [foam-file-format]: dev/foam-file-format.md "Foam File Format" -[wiki-links]: wiki-links.md "Wiki Links" +[wikilinks]: wikilinks.md "Wikilinks" [//end]: # "Autogenerated link references" diff --git a/docs/inbox.md b/docs/inbox.md index 30fed13a..74d06314 100644 --- a/docs/inbox.md +++ b/docs/inbox.md @@ -19,7 +19,7 @@ Uncategorised thoughts, to be added - - Future architecture - Could we do publish-related settings as a pre-push git hook, e.g. generating footnote labels - - Running them on Github Actions to edit stuff as it comes in + - Running them on GitHub Actions to edit stuff as it comes in - Ideally, we shouldn't have to touch files, should be just markdown - Looking at the errors/warnings/output panes makes me think, what kind of automated quality tools could we write. - Deduplication, finding similarities... diff --git a/docs/index.md b/docs/index.md index 57cf9fc6..c47a3218 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,7 +37,7 @@ Whether you want to build a [Second Brain](https://www.buildingasecondbrain.com/ 1. Create a single **Foam** workspace for all your knowledge and research following the [Getting started](#getting-started) guide. 2. Write your thoughts in markdown documents (I like to call them **Bubbles**, but that might be more than a little twee). These documents should be atomic: Put things that belong together into a single document, and limit its content to that single topic. ([source](https://zettelkasten.de/posts/overview/#principles)) -3. Use Foam's shortcuts and autocompletions to link your thoughts together with `[[wiki-links]]`, and navigate between them to explore your knowledge graph. +3. Use Foam's shortcuts and autocompletions to link your thoughts together with `[[wikilinks]]`, and navigate between them to explore your knowledge graph. 4. Get an overview of your **Foam** workspace using a [[graph-visualisation]] (⚠️ WIP), and discover relationships between your thoughts with the use of [[backlinking]]. Foam is a like a bathtub: _What you get out of it depends on what you put into it._ diff --git a/docs/publishing/generate-gatsby-site.md b/docs/publishing/generate-gatsby-site.md index 3fb6b904..aa23d882 100644 --- a/docs/publishing/generate-gatsby-site.md +++ b/docs/publishing/generate-gatsby-site.md @@ -2,11 +2,11 @@ ## Using foam-gatsby-template -You can use [foam-gatsby-template](https://github.com/mathieudutour/foam-gatsby-template) to generate a static site to host it online on Github or [Vercel](https://vercel.com). +You can use [foam-gatsby-template](https://github.com/mathieudutour/foam-gatsby-template) to generate a static site to host it online on GitHub or [Vercel](https://vercel.com). ### Publishing your foam to GitHub pages -It comes configured with Github actions to auto deploy to Github pages when changes are pushed to your main branch. +It comes configured with GitHub actions to auto deploy to GitHub pages when changes are pushed to your main branch. ### Publishing your foam to Vercel @@ -17,7 +17,7 @@ cd _layouts npm run build ``` -Remove `public` from your .gitignore file then commit and push your public folder in `_layouts` to Github. +Remove `public` from your .gitignore file then commit and push your public folder in `_layouts` to GitHub. Log into your Vercel account. (Create one if you don't have it already.) diff --git a/docs/publishing/publish-to-github-pages.md b/docs/publishing/publish-to-github-pages.md index 412727ac..919ab16c 100644 --- a/docs/publishing/publish-to-github-pages.md +++ b/docs/publishing/publish-to-github-pages.md @@ -1,4 +1,4 @@ -# Github Pages +# GitHub Pages - In VSCode workspace settings set `"foam.edit.linkReferenceDefinitions": "withoutExtensions"` - Execute the “Foam: Run Janitor” command from the command palette. diff --git a/docs/publishing/publish-to-vercel.md b/docs/publishing/publish-to-vercel.md index df68bd80..7c800383 100644 --- a/docs/publishing/publish-to-vercel.md +++ b/docs/publishing/publish-to-vercel.md @@ -82,6 +82,6 @@ Finally, if all is successful, Vercel will show the detected framework: Jekyll. And now, Vercel will take care of building and rendering our foam workspace each time on push. Vercel will publish our site to `xxx.vercel.app`, we can also define a custom domain name for our Vercel website. [//begin]: # "Autogenerated link references for markdown compatibility" -[publish-to-github-pages]: publish-to-github-pages.md "Github Pages" +[publish-to-github-pages]: publish-to-github-pages.md "GitHub Pages" [math-support-with-katex]: math-support-with-katex.md "Katex Math Rendering" [//end]: # "Autogenerated link references" diff --git a/docs/recipes/capture-notes-with-drafts-pro.md b/docs/recipes/capture-notes-with-drafts-pro.md index cd8b07f7..e50e095f 100644 --- a/docs/recipes/capture-notes-with-drafts-pro.md +++ b/docs/recipes/capture-notes-with-drafts-pro.md @@ -30,7 +30,7 @@ With this #recipe you can create notes on your iOS device, which will automatica 2. the repository name of your Foam repo 3. the GitHub access token from step 7 4. An author name -11. Check your Github repo for a commit +11. Check your GitHub repo for a commit 12. If you are publishing your Foam to the web you may want to edit your publishing configuration to exclude inbox files - as publishing (and method) is a user choice that is beyond the scope of this recipe ## Code for Drafts Action diff --git a/docs/recipes/diagrams-in-markdown.md b/docs/recipes/diagrams-in-markdown.md index a01a1c22..d39edeb1 100644 --- a/docs/recipes/diagrams-in-markdown.md +++ b/docs/recipes/diagrams-in-markdown.md @@ -27,5 +27,5 @@ You can use [Mermaid](https://marketplace.visualstudio.com/items?itemName=bierne 4. Embed the diagram file as you embedding the image file, for example: `![My Diagram](my-diagram.drawio.svg)` [//begin]: # "Autogenerated link references for markdown compatibility" -[publish-to-github-pages]: ../publishing/publish-to-github-pages.md "Github Pages" +[publish-to-github-pages]: ../publishing/publish-to-github-pages.md "GitHub Pages" [//end]: # "Autogenerated link references" diff --git a/docs/recipes/recipes.md b/docs/recipes/recipes.md index 44d054f2..720f6321 100644 --- a/docs/recipes/recipes.md +++ b/docs/recipes/recipes.md @@ -37,7 +37,7 @@ A #recipe is a guide, tip or strategy for getting the most out of your Foam work ## Write -- Link documents with [[wiki-links]]. +- Link documents with [[wikilinks]]. - Use shortcuts for [[creating-new-notes]] - Instantly create and access your [[daily-notes]] - Add and explore [[tags]] @@ -112,7 +112,7 @@ _See [[contribution-guide]] and [[how-to-write-recipes]]._ [graph-visualisation]: ../features/graph-visualisation.md "Graph Visualisation" [backlinking]: ../features/backlinking.md "Backlinking" [unlinked-references]: ../dev/unlinked-references.md "Unlinked references (stub)" -[wiki-links]: ../wiki-links.md "Wiki Links" +[wikilinks]: ../wikilinks.md "Wikilinks" [creating-new-notes]: ../features/creating-new-notes.md "Creating New Notes" [daily-notes]: ../features/daily-notes.md "Daily notes" [tags]: ../features/tags.md "Tags" @@ -127,7 +127,7 @@ _See [[contribution-guide]] and [[how-to-write-recipes]]._ [good-first-task]: ../dev/good-first-task.md "Good First Task" [git-integration]: ../features/git-integration.md "Git Integration" [write-your-notes-in-github-gist]: write-your-notes-in-github-gist.md "Write your notes in GitHub Gist" -[publish-to-github-pages]: ../publishing/publish-to-github-pages.md "Github Pages" +[publish-to-github-pages]: ../publishing/publish-to-github-pages.md "GitHub Pages" [publish-to-gitlab-pages]: ../publishing/publish-to-gitlab-pages.md "GitLab Pages" [publish-to-azure-devops-wiki]: ../publishing/publish-to-azure-devops-wiki.md "Publish to Azure DevOps Wiki" [publish-to-vercel]: ../publishing/publish-to-vercel.md "Publish to Vercel" diff --git a/docs/recipes/take-notes-from-mobile-phone.md b/docs/recipes/take-notes-from-mobile-phone.md index 37aa9550..3a647f7b 100644 --- a/docs/recipes/take-notes-from-mobile-phone.md +++ b/docs/recipes/take-notes-from-mobile-phone.md @@ -15,7 +15,7 @@ Pros - Provides functionality to edit, create, and browser markdown files. - Support journal mode, todo lists, and free writing - Syncs to GitHub repo -- Supports Wiki Links +- Supports Wikilinks - Supports Backlinks - Developer is happy to prioritize Foam compatibility diff --git a/docs/recommended-extensions.md b/docs/recommended-extensions.md index a919fcce..173443e2 100644 --- a/docs/recommended-extensions.md +++ b/docs/recommended-extensions.md @@ -19,6 +19,6 @@ These extensions are not (yet?) defined in `.vscode/extensions.json`, but have b - [Mermaid Markdown Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=bpruitt-goddard.mermaid-markdown-syntax-highlighting) - [VSCode PDF Viewing](https://marketplace.visualstudio.com/items?itemName=tomoki1207.pdf) - [Git Lens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens) -- [Markdown Extended](https://marketplace.visualstudio.com/items?itemName=jebbs.markdown-extended) (with `kbd` option disabled, `kbd` turns wiki-links into non-clickable buttons) +- [Markdown Extended](https://marketplace.visualstudio.com/items?itemName=jebbs.markdown-extended) (with `kbd` option disabled, `kbd` turns wikilinks into non-clickable buttons) - [GitDoc](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc) (easy version management via git auto commits) - [Markdown Footnotes](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-footnotes) (Adds [^footnote] syntax support to VS Code's built-in markdown preview) diff --git a/docs/wiki-links.md b/docs/wikilinks.md similarity index 87% rename from docs/wiki-links.md rename to docs/wikilinks.md index 82af285f..90dc1162 100644 --- a/docs/wiki-links.md +++ b/docs/wikilinks.md @@ -1,9 +1,9 @@ -# Wiki Links +# Wikilinks -Foam enables you to Link pages together using `[[file-name]]` annotations (i.e. `[[media-wiki]]` links). +Foam enables you to Link pages together using `[[file-name]]` annotations (i.e. `[[MediaWiki]]` links). - Type `[[` and start typing a file name for autocompletion. - - Note that your file names should be in `lower-dash-case.md`, and your wiki links should reference file names exactly: `[[lower-dash-case]]`, not `[[Lower Dash Case]]`. + - Note that your file names should be in `lower-dash-case.md`, and your wikilinks should reference file names exactly: `[[lower-dash-case]]`, not `[[Lower Dash Case]]`. - See [[link-formatting-and-autocompletion]] for more information, and how to setup your link autocompletions to make this easier. - `Cmd` + `Click` ( `Ctrl` + `Click` on Windows ) on file name to navigate to file (`F12` also works while your cursor is on the file name) - `Cmd` + `Click` ( `Ctrl` + `Click` on Windows ) on non-existent file to create that file in the workspace. @@ -12,7 +12,7 @@ Foam enables you to Link pages together using `[[file-name]]` annotations (i.e. ## Markdown compatibility -The [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) extension automatically generates [[link-reference-definitions]] at the bottom of the file to make wiki-links compatible with Markdown tools and parsers. +The [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) extension automatically generates [[link-reference-definitions]] at the bottom of the file to make wikilinks compatible with Markdown tools and parsers. ## Read more diff --git a/packages/foam-core/src/markdown-provider.ts b/packages/foam-core/src/markdown-provider.ts index 20a92ec2..e27ee103 100644 --- a/packages/foam-core/src/markdown-provider.ts +++ b/packages/foam-core/src/markdown-provider.ts @@ -451,7 +451,7 @@ export function createMarkdownReferences( ? relativePath : dropExtension(relativePath); - // [wiki-link-text]: path/to/file.md "Page title" + // [wikilink-text]: path/to/file.md "Page title" return { label: link.rawText.indexOf('[[') > -1 diff --git a/packages/foam-core/test/workspace.test.ts b/packages/foam-core/test/workspace.test.ts index c9774628..e49c4a85 100644 --- a/packages/foam-core/test/workspace.test.ts +++ b/packages/foam-core/test/workspace.test.ts @@ -369,7 +369,7 @@ describe('Wikilinks', () => { expect(graph.getLinks(noteA.uri).map(l => l.target)).toEqual([noteB1.uri]); }); - it('Handles capatalization of files and wiki links correctly', () => { + it('Handles capatalization of files and wikilinks correctly', () => { const noteA = createTestNote({ uri: '/path/to/page-a.md', links: [ diff --git a/packages/foam-vscode/README.md b/packages/foam-vscode/README.md index dbb3b4b1..9e19225f 100644 --- a/packages/foam-vscode/README.md +++ b/packages/foam-vscode/README.md @@ -28,8 +28,8 @@ You really, _really_, **really** should read [Foam documentation](https://foambu ## Features -- Connect your notes using [`[[wiki-links]]`](https://foambubble.github.io/foam/features/backlinking) -- Create markdown [references](https://foambubble.github.io/foam/features/link-reference-definitions) for `[[wiki-links]]`, to use your notes in a non-foam workspace +- Connect your notes using [`[[wikilinks]]`](https://foambubble.github.io/foam/features/backlinking) +- Create markdown [references](https://foambubble.github.io/foam/features/link-reference-definitions) for `[[wikilinks]]`, to use your notes in a non-foam workspace - See how your notes are connected via a [graph](https://foambubble.github.io/foam/features/graph-visualisation) with the `Foam: Show Graph` command - Tag your notes and navigate them with the [Tag Explorer](https://foambubble.github.io/foam/features/tags) - Make your notes navigable both in GitHub UI as well as GitHub Pages diff --git a/packages/foam-vscode/src/features/link-completion.spec.ts b/packages/foam-vscode/src/features/link-completion.spec.ts index 45b843b7..dcd0db59 100644 --- a/packages/foam-vscode/src/features/link-completion.spec.ts +++ b/packages/foam-vscode/src/features/link-completion.spec.ts @@ -73,7 +73,7 @@ describe('Link Completion', () => { expect(links.items.length).toEqual(4); }); - it('should not return link outside the wiki-link brackets', async () => { + it('should not return link outside the wikilink brackets', async () => { const { uri } = await createFile('[[file]] then'); const { doc } = await showInEditor(uri); const provider = new CompletionProvider(ws, graph); diff --git a/readme.md b/readme.md index cf7702a5..6d38f26f 100644 --- a/readme.md +++ b/readme.md @@ -22,7 +22,7 @@ Whether you want to build a [Second Brain](https://www.buildingasecondbrain.com/ 1. Create a single **Foam** workspace for all your knowledge and research following the [[Getting started]] guide. 2. Write your thoughts in markdown documents (I like to call them **Bubbles**, but that might be more than a little twee). These documents should be atomic: Put things that belong together into a single document, and limit its content to that single topic. ([source](https://zettelkasten.de/posts/overview/#principles)) -3. Use Foam's shortcuts and autocompletions to link your thoughts together with `[[wiki-links]]`, and navigate between them to explore your knowledge graph. +3. Use Foam's shortcuts and autocompletions to link your thoughts together with `[[wikilinks]]`, and navigate between them to explore your knowledge graph. 4. Get an overview of your **Foam** workspace using the [[Graph Visualisation]], and discover relationships between your thoughts with the use of [[Backlinking]]. ![Foam kitchen sink, showing a few of the key features](docs/assets/images/foam-features-dark-mode-demo.png) @@ -48,7 +48,7 @@ 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" -[wiki-links]: docs/wiki-links.md "Wiki Links" +[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"