mirror of
https://github.com/foambubble/foam.git
synced 2026-04-24 03:01:01 -04:00
a23e73245f
* changed vscode setting to include extensions in link definition * updated docs to include extension in wikilink definition * updated readme to navigate to github pages instead of published site
1.5 KiB
1.5 KiB
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]].
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]]:
- It needs to have a single top level
# Heading.- This will be used as document title.
- [decision-needed] Do we need it?
- [decision-needed] How much to deviate from just markdown
- This will be used as document title.
- File name should not contain spaces, e.g.
foam-file-format.mdis a valid name, butFoam File Format.mdis not.- This is a temporary limitation and will be lifted in future versions.
- Technically this actually works already, but may have some edge cases you don't want to deal with if you can avoid it.
- File name should have extension
.mdor.markdown- This is a temporary limitation and will be lifted in future versions.
- At least
.mdxwill be supported, but ideally we'll support any file that you can map toMarkdownlanguage mode in VS Code
- In addition to normal Markdown Links syntax you can use
[[media-wiki]]links. See [wiki-links] for more details.