README.md

memospot.github.io

Memospot landing page and documentation.

Technology Stack

• Astro - Static site generator
• Starlight - Astro documentation framework
• MDX - Markdown with embedded JSX components
• Tailwind CSS - Utility-first CSS framework
• Bun - JavaScript runtime and package manager
• Biome - Linter (formatting is handled by dprint)
• dprint - Code formatting

Project Structure

In this project, you'll see the following folders and files:

.
├── public/                (Static assets like favicons and robots.txt)
├── src/
│   ├── assets/            (Images and other media)
│   ├── components/        (Astro components used across the site)
│   ├── content/
│   │   └── docs/          (Mdx files for documentation)
│   ├── styles/            (CSS styles)
│   └── content.config.ts  (Controls how content is loaded and displayed)
├── astro.config.ts        (Astro configuration. Contains the sidebar links.)
└── justfile               (Task runner file with common commands)

Installing Dependencies with Homebrew

brew install \
  oven-sh/bun/bun \
  dprint \
  just \
  prek

Biome is managed as a project dependency and installed with bun install.

Commands

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

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

For consistency with the parent project, a justfile is also provided with similar commands. Run just on the project directory to see a list of available tasks.

Learn more

• Starlight’s docs
• Astro documentation
• MDX documentation
• Tailwind CSS documentation
• Bun documentation

Contributing

See CONTRIBUTING.md for setup, Git hooks, and the checks to run before pushing. The site's contribution guide covers the Memospot application itself.