Skip to content

ScottyLabs/cmu-guide

Repository files navigation

CMU First-Year Guide

Usage

This project uses Bun. 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 build Build your production site to ./dist/
bun preview Preview your build locally, before deploying
bun astro ... Run CLI commands like astro add, astro check
bun astro -- --help Get help using the Astro CLI

Since pagefind requires a build artifact, search will only work on bun preview after running bun build.

Project Structure

Astro looks for .md files in the src/pages/ directory. Each page is exposed as a route based on its file name. Any static assets, like images, should be placed in the public/ directory.

For more comprehensive instructions, visit the visit the Markdown content docs, or more generally, the Astro documentation.

Favicons were generated using favicon-generator.org.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •