mirror of
https://github.com/foambubble/foam.git
synced 2026-04-24 03:01:01 -04:00
80 lines
3.0 KiB
Markdown
80 lines
3.0 KiB
Markdown
# Installation
|
|
|
|
Getting started with Foam is straightforward. This guide will walk you through installing everything you need to begin your knowledge management journey.
|
|
|
|
## Step 1: Install Visual Studio Code
|
|
|
|
Foam is built on VS Code, Microsoft's free, open-source code editor. You can download it at https://code.visualstudio.com/
|
|
|
|
### Why VS Code?
|
|
|
|
VS Code provides:
|
|
|
|
- Excellent Markdown editing capabilities
|
|
- Rich extension ecosystem
|
|
- Cross-platform compatibility
|
|
- Integrated terminal and Git support
|
|
- Customizable interface and shortcuts
|
|
|
|
To learn more about using VS Code with Foam, check [[get-started-with-vscode]]
|
|
|
|
## Step 2: Install the Foam Extension
|
|
|
|
The Foam extension adds knowledge management superpowers to VS Code.
|
|
|
|
1. **Open VS Code**
|
|
2. **Click the Extensions icon** in the sidebar (or press `Ctrl+Shift+X` / `Cmd+Shift+X`)
|
|
3. **Search for "Foam"** in the extensions marketplace
|
|
4. **Click "Install"** on the official Foam extension by Foam Team
|
|
5. **Reload VS Code** when prompted
|
|
|
|
### What the Foam Extension Provides
|
|
|
|
- Wikilink auto-completion and navigation
|
|
- Backlink discovery and panel
|
|
- Graph visualization
|
|
- Powerful note template engine
|
|
- Daily notes functionality
|
|
|
|
## Step 3: Install Recommended Extensions
|
|
|
|
While Foam works on its own, it is focused on the networking aspect of your notes. You might want to install additional extensions to improve the editing experience or the functionality of your notes.
|
|
|
|
### Useful Extensions
|
|
|
|
- **Markdown All in One** - Rich Markdown editing features. Highly recommended.
|
|
|
|
Other extensions:
|
|
|
|
- **Spell Right** - Spell checking for your notes
|
|
- **Paste Image** - Easily insert images from clipboard
|
|
- **Todo Tree** - Track TODO items across your workspace
|
|
|
|
## What's Next?
|
|
|
|
Now that Foam is installed, you're ready to:
|
|
|
|
1. **[[first-workspace]]** - Set up your knowledge base structure
|
|
2. **[[get-started-with-vscode]]** - Learn how to use VS Code for note taking
|
|
3. **[[note-taking-in-foam]]** - Write your first Markdown notes
|
|
4. **[[navigation]]** - Connect your thoughts with wikilinks
|
|
5. **[[graph-view]]** - Visualize your knowledge network
|
|
|
|
## Getting Help
|
|
|
|
If you encounter issues:
|
|
|
|
- Check the [[frequently-asked-questions]] for common problems
|
|
- Visit the [Foam Community Discord](https://foambubble.github.io/join-discord/w)
|
|
- Browse [GitHub Issues](https://github.com/foambubble/foam/issues) for known problems
|
|
- Ask questions in [GitHub Discussions](https://github.com/foambubble/foam/discussions)
|
|
|
|
[//begin]: # "Autogenerated link references for markdown compatibility"
|
|
[get-started-with-vscode]: get-started-with-vscode.md "Using Foam with VS Code Features"
|
|
[first-workspace]: first-workspace.md "Creating Your First Workspace"
|
|
[note-taking-in-foam]: note-taking-in-foam.md "Note-Taking in Foam"
|
|
[navigation]: navigation.md "Navigation in Foam"
|
|
[graph-view]: ../features/graph-view.md "Graph Visualization"
|
|
[frequently-asked-questions]: ../frequently-asked-questions.md "Frequently Asked Questions"
|
|
[//end]: # "Autogenerated link references"
|