ANQ Notes

A typed static site generator that turns Markdown into a complete publication and checks links before replacing the previous build.

  • TypeScript
  • Markdown
  • Static HTML
Type
Static publication tool
My focus
Content, typography and accessible reading
The outcome
A small writing site that works without browser JavaScript.

A fictional publication generated from Markdown.

ANQ Notes sample writing index with fictional articles and topic links ANQ Notes sample writing index with fictional articles and topic links
Interface shown with fictional sample data. View full screenshotView full screenshotView full screenshotView full screenshot

From writing to a working publication

ANQ Notes turns a folder of writing into a complete website. Edit Markdown posts, add pages and local images, then build a publication with topics, pagination, RSS and a sitemap. Readers can use the resulting site without browser JavaScript.

The project covers both sides of that workflow: a reading interface and the TypeScript tool that prepares and checks its output. The public sample is built from fictional writing and uses the same templates available in the repository.

Give readers a clear way through

Writing, Topics and About identify the current section. Listing pages include page numbers in their titles. Posts link to the previous and next published notes in a consistent order.

Page templates and shared cards are separate from build orchestration. Typography, spacing and colour live in local CSS tokens, so the publication can be adapted without rewriting the generator. A keyboard skip link reaches the reading area.

A bad edit should not erase the working site

A missing image, broken fragment or conflicting slug can make a publication unusable. The build checks those problems before replacing generated output. Invalid content leaves the previous successful build available; a successful build removes obsolete routes.

The tool also sanitizes content HTML, validates dates and metadata, and prevents overlapping builds. Drafts stay out of pages, topics and feeds. Configuration and templates remain trusted code, while content is parsed and checked as data.

Evidence to inspect

The build orchestration shows validation, staging and output replacement. Integration tests cover failed build preservation, links, drafts, ordering, sanitization and unsafe source paths. Browser tests navigate with JavaScript disabled and check pagination, XML output, missing pages, mobile layouts and automated accessibility. GitHub CI runs the build and checks on pushes and pull requests.

The sample is served publicly over HTTPS. Its static container has been checked as an unprivileged user with a read-only filesystem.

Scope and implementation

Notes is a project to clone and adapt. It builds plain files; production rollout and rollback belong to the hosting setup. The generator checks internal links, not the continued availability of external websites. Plugins, live editing and client-side search are outside this version.

Top