Skip to content

brickfrog/ametrine

Repository files navigation

Ametrine Logo

Ametrine

A modern digital garden built with Astro, featuring wikilinks, backlinks, graph visualization, and full-text search.

Features

  • Wikilink Support: Use [[Page Name]] syntax to link between notes
  • Backlinks: Automatically see which pages link to the current page
  • Graph Visualization: Interactive D3 force-directed graph of note connections
  • Full-Text Search: Fast search across all notes with Cmd+K shortcut
  • Table of Contents: Auto-generated TOC with scroll highlighting
  • Tags: Organize notes with tags and browse by tag
  • Dark Mode: System-aware theme with manual toggle
  • Responsive: Three-column layout that adapts to screen size
  • Fast: Built with Astro for optimal performance
  • Smart Caching: LocalStorage caching prevents layout jitter

Project Structure

/
β”œβ”€β”€ public/              # Static assets (favicon, images)
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/      # Astro and React components
β”‚   β”œβ”€β”€ content/
β”‚   β”‚   β”œβ”€β”€ vault/       # Your notes (.md), bases (.base), canvases (.canvas)
β”‚   β”‚   └── bibliography.bib  # Citation references
β”‚   β”œβ”€β”€ layouts/         # Page layouts
β”‚   β”œβ”€β”€ pages/           # Routes and API endpoints
β”‚   β”œβ”€β”€ plugins/         # Remark/Rehype plugins
β”‚   β”œβ”€β”€ styles/          # Global CSS
β”‚   β”œβ”€β”€ utils/           # Utility functions
β”‚   └── config.ts        # Site configuration
└── package.json

Commands

All commands are run from the root of the project, from a terminal:

Command Action
bun install Installs dependencies
bun run dev Starts local dev server at localhost:4321
bun run build Build your production site to ./dist/
bun run preview Preview your build locally, before deploying
bun run astro ... Run CLI commands like astro add, astro check

Getting Started

After cloning this template, customize it for your site:

  • Update site title, description, and logo in src/config.ts
  • Modify footer links in src/config.ts
  • Customize theme colors and typography in src/config.ts
  • Replace logo in public/ametrine.png
  • Delete or replace example notes in src/content/vault/
  • Update baseUrl in src/config.ts for production deployment

Customization

  • Edit src/config.ts to change site title, theme, and typography
  • Customize styles in src/styles/global.css

Deployment

Build your site for production:

bun run build

Deploy the ./dist/ folder to any static hosting service (Vercel, Netlify, Cloudflare Pages, etc.)

Thanks

Inspired by Quartz

License

MIT