mirror of
https://github.com/foambubble/foam.git
synced 2026-04-24 03:01:01 -04:00
72694ad201
* Reorganize docs folder; isolate dev docs and user docs; integrate foam-template docs * Rename how-to to getting-started * Fixup all references * Fix contribution-guide.md * Fix asset references * Fix user/index.md * Spelling is good. Thanks @DrakeWhu * Add note about how to wite docs for foam
1.0 KiB
1.0 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 [[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 [[wikilinks]]:
- The first top level
# Headingwill 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
.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
[[MediaWiki]]links. See [wikilinks] for more details.