Giter Club home page Giter Club logo

astro-paper's Introduction

AstroPaper ๐Ÿ“„

astro-paper Typescript GitHub Conventional Commits Commitizen friendly

AstroPaper is a minimal, responsive and SEO-friendly Astro blog theme. This theme is designed and crafted based on my personal blog.

This theme is aimed to be accessible out of the box. Light and dark mode are supported by default and additional color schemes can also be configured.

This theme is self-documented _ which means articles/posts in this theme can also be considered as documentations. So, see the documentation for more info.

๐Ÿ”ฅ Features

  • super fast performance
  • fully responsive and accessible
  • SEO-friendly
  • light & dark mode
  • fuzzy search
  • draft posts & pagination
  • sitemap & rss feed
  • highly customizable

๐Ÿš€ Project Structure

Inside of AstroPaper, you'll see the following folders and files:

/
โ”œโ”€โ”€ public/
โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ””โ”€โ”€ logo.svg
โ”‚   โ”‚   โ””โ”€โ”€ logo.png
โ”‚   โ””โ”€โ”€ favicon.svg
โ”‚   โ””โ”€โ”€ default-og.png
โ”‚   โ””โ”€โ”€ robots.txt
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ””โ”€โ”€ socialIcons.ts
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”œโ”€โ”€ contents/
โ”‚   โ”‚   โ””โ”€โ”€ some-blog-posts.md
โ”‚   โ”œโ”€โ”€ layouts/
โ”‚   โ””โ”€โ”€ pages/
โ”‚   โ””โ”€โ”€ styles/
โ”‚   โ””โ”€โ”€ utils/
โ”‚   โ””โ”€โ”€ config.ts
โ”‚   โ””โ”€โ”€ types.ts
โ””โ”€โ”€ package.json

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

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

All blog posts are stored in src/contents/ directory.

๐Ÿ“– Documentation

Documentation can be read in two formats_ markdown & blog post.

๐Ÿ’ป Tech Stack

Main Framework - Astro
Type Checking - TypeScript
Component Framework - ReactJS
Styling - TailwindCSS
UI/UX - Figma
Fuzzy Search - FuseJS
Icons - Boxicons | Tablers
Deployment - Cloudflare Pages
Illustration in About Page - https://freesvgillustration.com

๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป Running Locally

The easiest way to run this project locally is to run the following command in your desired directory.

npm create astro@latest -- --template satnaing/astro-paper

Don't forget to remove Google site varification.

# in your project directory
rm -rf public/googlebbcd930f1ecacd3a.html

๐Ÿงž 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 cz Commit code changes with commitizen
npm run astro ... Run CLI commands like astro add, astro preview
npm run astro --help Get help using the Astro CLI

โœจ Feedback & Suggestions

If you have any suggestions/feedback, you can contact me via my email. Alternatively, feel free to open an issue if you find bugs or want to request new features.

๐Ÿ“œ License

Licensed under the MIT License, Copyright ยฉ 2022


Made with ๐Ÿค by Sat Naing ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป

astro-paper's People

Contributors

akarachen avatar elpekenin avatar satnaing avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.