|
||
---|---|---|
.husky | ||
.idea | ||
public | ||
src | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
.markdownlint.json | ||
.npmrc | ||
.prettierignore | ||
.prettierrc | ||
AstroPaper-lighthouse-score.svg | ||
LICENSE | ||
README.md | ||
astro.config.mjs | ||
package-lock.json | ||
package.json | ||
tailwind.config.cjs | ||
tsconfig.json |
README.md
My blog using astro.build and the astropaper theme.
AstroPaper 📄
AstroPaper is a minimal, responsive, accessible and SEO-friendly Astro blog theme. This theme is designed and crafted based on my personal blog.
👨🏻💻 Running Locally
The easiest way to run this project locally is to run the following command in your desired directory.
# npm 6.x
npm create astro@latest --template satnaing/astro-paper
# npm 7+, extra double-dash is needed:
npm create astro@latest -- --template satnaing/astro-paper
# yarn
yarn create astro --template satnaing/astro-paper
🧞 Commands
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:3000 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run format:check |
Check code format with Prettier |
npm run format |
Format codes with Prettier |
npm run sync |
Generates TypeScript types for all Astro modules. Learn more. |
npm run cz |
Commit code changes with commitizen |
npm run lint |
Lint with ESLint |