Getting Started

This page gets you from zero to a working AS Notes workspace in a few minutes.

1. Install the Extension

Install AS Notes from Visual Studio Marketplace / Open VSX

Open VS Code, go to the Extensions view (Ctrl+Shift+X), search for AS Notes, and click Install.

2. Open a Folder

AS Notes works with markdown files and assets in a VS Code workspace folder, or a subdirectory within a workspace. If you don't have one yet, create an empty folder and open it in VS Code (File → Open Folder).

Want a ready-made example? Clone the AS Notes demo notes repository and open it in VS Code.

3. Initialise the Workspace

AS Notes does not activate until you initialise your workspace. You will see a status bar item at the bottom of VS Code inviting you to do so.

Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
Run AS Notes: Initialise Workspace

This creates a .asnotes/ directory at the workspace root, builds a SQLite index of all your markdown files, and activates all extension features. The index file is automatically added to .gitignore.

After initialisation the status bar shows AS Notes (or AS Notes (Pro) if you have a licence key configured).

Look for the AS Notes sidebar icon to view Search, Calendar, Kanban Boards and Tasks

4. Write Your First Note

Create a new .md file and start writing. Type [[ anywhere to trigger Wikilinks autocomplete - a list of all your pages appears immediately (unless this is your first page and wikilink, in which case it will be added too the index ready for referencing).

Next, try adding a task - [ ] task text (Ctrl+Shift+Enter / Cmd+Shift+Enter) and try toggling the task state from the task management side panel or by clicking the check box or by cycling the keyboard shortcut.

Excluding Files from the Index

When AS Notes initialises, it creates a .asnotesignore file at the workspace root. This file controls which files and directories are excluded from the index, using .gitignore pattern syntax.

The default contents exclude some common tool directories:

# Logseq metadata and backup directories
logseq/

# Obsidian metadata and trash directories
.obsidian/
.trash/

Edit .asnotesignore any time - AS Notes watches the file and re-scans automatically when it changes. Newly ignored files are removed from the index; un-ignored files are added.

.asnotesignore is version-controlled and user-editable. AS Notes will never overwrite it after initial creation.

Rebuilding the Index

If the index ever becomes stale or corrupted, run AS Notes: Rebuild Index from the Command Palette. This drops and recreates the entire index with a progress indicator.

Cleaning the Workspace

Run AS Notes: Clean Workspace to remove the .asnotes/ directory and reset all in-memory state. Your .asnotesignore file is preserved. Run AS Notes: Initialise Workspace afterwards to start fresh.

Compatibility With Other Tools

AS Notes workspaces are plain markdown files in plain folders - they are largely compatible with Obsidian and Logseq due to similar file structures. Be aware there are format and behavioural differences, but you can use the same notes folder with multiple tools.