README.md

Jiahua's Homepage

homey home on the internet kinda place

Stack

The site is built using Astro and Yarn.

Structure

Astro creates routes based on pages in the src/pages folder. Add .astro (mix of JavaScript and HTML) or .mdx (Markdown with JSX components) files to create new pages on the site. src/components contains components, some are TypeScript React and some are Astro components. src/layouts contains base layouts for pages. This includes the header, style, footer, nav bar components so your content can be directly included in. All styles are in src/styles. Components, layouts, assets, styles can be accessed using @components, @layouts, etc.

Here's an example file directory:

/
├── public/
│   └── favicon.ico
├── src/
│   ├── components/
│   │   └── Card.astro
│   ├── content/
│   │   └── blog/
│   │       ├── post1.mdx
│   │       └── post2.mdx
│   ├── layouts/
│   │   └── Base.astro
│   └── pages/
│       └── index.astro
└── package.json

Commands

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

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

Generally, running yarn dev will create a live version of the website as you make edits.