Skip to content

Getting Started

Gareth Brown edited this page Apr 1, 2026 · 1 revision

Getting Started

Install AS Notes and start writing in under two minutes.

1. Install

Search for AS Notes in the VS Code Extensions view (Ctrl+Shift+X) and click Install.

Or install from:

2. Open a Folder

Open any folder containing markdown files (File → Open Folder). For a ready-made example, clone the demo notes.

3. Initialise

Open the Command Palette (Ctrl+Shift+P) and run AS Notes: Initialise Workspace. This builds the index and activates all features.

4. Start Writing

Create a .md file and type [[ to see wikilink autocomplete. Add tasks with - [ ] and toggle them with Ctrl+Shift+Enter.

Using AS Notes with GitHub Wiki

You can use AS Notes to edit GitHub wiki repositories locally. Clone your wiki, initialise AS Notes, and get full wikilink support, backlinks, and autocomplete on your wiki pages. See the Editing GitHub Wiki guide for the full workflow.

Learn More

Full documentation is at docs.asnotes.io.


This page is part of the AS Notes wiki example. Full documentation: docs.asnotes.io

Back to Home

Clone this wiki locally