Skip to content

Commit 936b273

Browse files
committed
Added introductory blog post
1 parent 97c9575 commit 936b273

4 files changed

Lines changed: 136 additions & 4 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -855,7 +855,7 @@ Both themes output formatted, human-editable CSS (`theme-{name}.css`). They use
855855
| `--base-url <path>` | Base URL prefix for all links |
856856
| `--default-public` | Publish all pages unless `public: false` |
857857
| `--default-assets` | Copy all assets unless `assets: false` |
858-
| `--retina` | Generate retina-compatible image markup |
858+
| `--retina` | Enable retina image sizing (auto-sets `width` to half intrinsic dimensions) |
859859
| `--include-drafts` | Include pages with `draft: true` |
860860
| `--exclude <dirname>` | Exclude directories from scanning (repeatable) |
861861

293 KB
Loading
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
title: Introducing AS Notes
3+
description: AS Notes brings wikilink-style note-taking into VS Code. Capture ideas, link concepts, manage tasks, and now publish your notes as a static website.
4+
date: 2026-03-24
5+
order: 1
6+
---
7+
8+
# Introducing AS Notes
9+
10+
Thank you for finding your way to our new blog. We'd like to introduce you to **AS Notes**:
11+
12+
Most note-taking tools want you to leave your editor. AS Notes doesn't. It brings `[[wikilink]]` style knowledge management directly into VS Code, where many of us already spend most of our day.
13+
14+
No Electron wrapper. No separate app to context-switch into. Just your editor, your markdown files, and a lightweight SQLite index that ties everything together.
15+
16+
![AS Notes Screenshot](../assets/images/as-notes-screen-shot.png)
17+
18+
## What you get
19+
20+
AS Notes is a Personal Knowledge Management System that runs as a VS Code extension. At its core: you write markdown files, link them with `[[wikilinks]]`, and the extension handles resolution, backlinks, renaming, and navigation across your entire workspace.
21+
22+
But it goes further than that.
23+
24+
**Wikilinks that actually work.** Links resolve globally across your workspace. Nested links like `[[Specific [[Topic]] Details]]` create multiple navigable targets. Rename a link and every reference updates. Case-insensitive matching, page aliases, subfolder resolution - it handles the edge cases so you don't have to.
25+
26+
**Task management built into your notes.** Toggle TODOs with `Ctrl+Shift+Enter`. Add priority (`#P1`, `#P2`, `#P3`), due dates (`#D-2026-03-20`), and waiting flags (`#W`) as inline hashtags. The Tasks panel aggregates everything across your workspace with grouping by page, priority, due date, or completion date.
27+
28+
**Kanban boards backed by markdown.** Each card is a `.md` file with YAML front matter. Drag cards between lanes, add entries, attach files. Every change is a diffable text file you can version control.
29+
30+
**Daily journaling.** `Ctrl+Alt+J` creates today's journal from a template. A calendar panel in the sidebar shows which days have entries. Click any day to open it.
31+
32+
**Backlinks with full context.** The backlinks panel shows every incoming link as a chain - the full outline path from root to link. Group by page or by chain pattern. Click any link to jump straight to the source line.
33+
34+
**Outliner mode.** Toggle it on and every line starts with a bullet. Tab/Shift+Tab for indentation, Enter continues the list, and multi-line paste splits into individual bullets.
35+
36+
**Slash commands.** Type `/` for quick access to date insertion, code blocks, tables (with add/remove column and row operations), templates, and task metadata.
37+
38+
All of this runs on plain markdown files. No proprietary format. No lock-in. Git-friendly from day one.
39+
40+
## Publishing your notes as a static site
41+
42+
This is the feature we've most recently shipped. AS Notes now includes a built-in tool that converts your markdown notes into a static website.
43+
44+
The documentation you're reading right now was written in AS Notes and published using the same tool.
45+
46+
### How it works
47+
48+
Point the converter at a folder of markdown files and it produces clean HTML. Wikilinks between pages resolve to the correct `.html` links automatically. A navigation sidebar is generated from your public pages. Output filenames are slugified to clean URLs (`Getting Started.md` becomes `getting-started.html`).
49+
50+
You control what gets published with YAML front matter:
51+
52+
```yaml
53+
---
54+
public: true
55+
title: My Page
56+
description: A short description for SEO
57+
layout: docs
58+
date: 2026-03-24
59+
---
60+
```
61+
62+
Pages without `public: true` are skipped. Or pass `--default-public` to publish everything unless a page opts out. Encrypted `.enc.md` files are always excluded - a hardcoded safety net.
63+
64+
### Layouts and themes
65+
66+
Three built-in layouts ship out of the box:
67+
68+
- **docs** - sidebar navigation with content area (what you're looking at)
69+
- **blog** - sidebar with a narrower, article-style content area and date display
70+
- **minimal** - content only, no navigation
71+
72+
Two themes are included (`default` and `dark`), both producing clean, editable CSS. You can override per-page with front matter, bring your own stylesheets, or create entirely custom layouts with template tokens like `{{content}}`, `{{nav}}`, and `{{toc}}`.
73+
74+
### Asset pipeline, SEO, and feeds
75+
76+
Referenced images are automatically discovered and copied to the output. Retina support is built in - per-image with `{.retina}`, per-page via front matter, or globally with `--retina`.
77+
78+
Every site gets a `sitemap.xml` and an RSS `feed.xml` generated automatically. Add `description:` front matter for `<meta>` SEO tags. Set `--base-url` for subdirectory deployments.
79+
80+
### Run it anywhere
81+
82+
Install as an npm package for CI/CD:
83+
84+
```bash
85+
npx asnotes-publish --config ./asnotes-publish.json
86+
```
87+
88+
Or run it directly from VS Code with the **AS Notes: Publish to HTML** command.
89+
90+
The config file keeps things reproducible:
91+
92+
```json
93+
{
94+
"inputDir": "./pages",
95+
"outputDir": "../docs",
96+
"defaultPublic": true,
97+
"layout": "docs",
98+
"theme": "default",
99+
"baseUrl": ""
100+
}
101+
```
102+
103+
Deploy to GitHub Pages, Netlify, Vercel, Cloudflare Pages - anywhere that serves static files.
104+
105+
### Custom navigation
106+
107+
Don't want auto-generated navigation? Create a `nav.md` at the root of your input directory. Write it in markdown with wikilinks and it becomes the sidebar for every page:
108+
109+
```markdown
110+
## Guides
111+
112+
- [[Getting Started]]
113+
- [[Publishing a Static Site]]
114+
115+
---
116+
117+
## Reference
118+
119+
- [[Settings]]
120+
- [[Wikilinks]]
121+
```
122+
123+
## Privacy first
124+
125+
AS Notes does not send your data anywhere. The index is a local SQLite database. Your encryption keys are stored in the OS keychain. Your notes stay on your machine (or wherever you choose to sync them).
126+
127+
## Getting started
128+
129+
Install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=appsoftwareltd.as-notes). Open the Command Palette and run **AS Notes: Initialise Workspace**. That's it.
130+
131+
For a sample knowledge base to explore, clone the [demo repository](https://github.com/appsoftwareltd/as-notes-demo-notes).
132+
133+
For publishing, the [documentation](https://docs.asnotes.io) covers the full setup - front matter fields, layouts, themes, asset pipeline, CI/CD configuration, and multi-site publishing.
134+
135+
AS Notes is free. Pro features (templates, table commands, kanban, encrypted notes) are available with a licence key from [asnotes.io](https://www.asnotes.io/pricing).

docs-src/blog/welcome-to-as-notes-blog.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)