astro-resume icon indicating copy to clipboard operation
astro-resume copied to clipboard

Published 20 hours ago • verified publisher icon EmaSuriano
→

Metadata

Resume builder written in Markdown using Astro with Tailwind

astro-resume

master Dependabot status Netlify Status This project is using Percy.io for visual regression testing.

Resume builder based on Markdown and Tailwind CSS. Built with Astro, and inspired by Standard Resume.

Demo

Features

  • Full Tailwind CSS integration with @tailwindcss/typography plugin
  • Dark mode ready with :dark tag powered by Tailwind CSS
  • No need for complex data structure, just write your information in Markdown!
  • Resume PDF generation using Playwright
  • Ready for deployment with Netlify or any static website hosting.
  • Fonts powered by Fontsource
  • Full Typescript support

UI

Light mode

Desktop Tablet Phone
Desktop Light Tablet light Phone light

Dark mode

Desktop Tablet Phone
Desktop Light Tablet light Phone light

PDF Generated

Page 1 Page 2
Pdf Page 1 Pdf Page 2

Project Structure

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

The pdf is generated at build time, so no need to manually generated it.

Commands

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

Command Action
yarn Installs dependencies
yarn dev Starts local dev server at localhost:4321
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 preview
yarn astro --help Get help using the Astro CLI

How to setup your own resume?

  • You can quickly clone this repository by clicking on Use this template.
  • After your repository is created, you should modify index.md with your information.
  • Once you are done, push your changes into your repository.
  • Select any of the available options to deploy your websites. This project already provides the setup to deploy with Netlify, you can check this guide for more information.

Contributing

Feel free to open issues or/and pull requests into this repository to improve it!

License

MIT.

← Metadata

67
Stars
6
Forks
Watchers

Owner

verified publisher icon EmaSuriano

Metadata

Resume builder written in Markdown using Astro with Tailwind

Back