Skip to content

sanman1k98/www

Repository files navigation

✨ Tech

  • Astro: JavaScript web framework
  • UnoCSS: CSS utility framework
  • Content Collections: Manages Markdown and image content
    • Used to create resume and photo pages
  • Satori: Converts HTML and CSS to SVG
    • Used to create favicon images

💻 Developing

git clone --recurse-submodules https://github.com/sanman1k98/www.git

Note

This project uses a private git submodule for the "cv" content collection which is used to generate the /resume page.

🧞 Commands

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

Command Action
pnpm install Installs dependencies
pnpm run dev Starts local dev server at localhost:4321
pnpm run check Check project for type errors
pnpm run build Build your production site to ./dist/
pnpm run preview Preview your build locally, before deploying
pnpm run deploy Build and push to trigger deployment workflow
pnpm run astro ... Run CLI commands like astro add, astro check
pnpm run astro --help Get help using the Astro CLI

🚀 Deploying

The site is hosted on GitHub Pages using static files in the deploy branch. Deployments are triggered when the repository owner (me) pushes to the deploy branch.

"Why deploy from a branch?"
  • All deployments can be accessed simply via git: for example, git log deploy
  • GitHub Pages Classic used to to work in a similar way: it would deploy your site using files from a branch named gh_pages
  • Because why not 🤷🏽‍♂

📜 License

Source code is licensed under MIT.

About

Source code for my website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors