|
1 | | -# Space Ahead ✨ - An Astro v6 Personal Blog Template |
| 1 | +# HangbaSteve's Blog |
2 | 2 |
|
3 | | -A minimal space-inspired personal blog template, created by Siddhesh Thadeshwar. |
| 3 | +Welcome to my personal blog source code repository! |
4 | 4 |
|
5 | | -> ## Now ready for Astro v6. 🥳 |
| 5 | +This site is built with [Astro](https://astro.build/) and is automatically deployed to GitHub Pages. |
6 | 6 |
|
7 | | - |
| 7 | +## 📊 GitHub Stats |
8 | 8 |
|
9 | | -See the [demo](https://djsiddz.github.io/space-ahead) to know more. | View on Astro's [Theme Directory](https://astro.build/themes/details/space-ahead/). |
| 9 | +<p align="center"> |
| 10 | + <img src="https://github-readme-activity-graph.vercel.app/graph?username=Hangba&theme=react-dark" width="100%" alt="GitHub Activity Graph" /> |
| 11 | +</p> |
10 | 12 |
|
11 | | -## 🆕 Real-like Demo |
| 13 | +<p align="center"> |
| 14 | + <img src="https://github-readme-stats.vercel.app/api?username=Hangba&show_icons=true&theme=react-dark" width="48%" alt="GitHub Stats" /> |
| 15 | + <img src="https://github-readme-stats.vercel.app/api/top-langs/?username=Hangba&layout=compact&theme=react-dark" width="48%" alt="Top Languages" /> |
| 16 | +</p> |
12 | 17 |
|
13 | | -View **Mumbai Stories** - [Samay Anand's Blog](https://djsiddz.github.io/samay-anand)! 🏏 | [View Source Code](https://github.com/djsiddz/samay-anand). |
| 18 | +## 🚀 Local Development |
14 | 19 |
|
15 | | -## Theme Features |
| 20 | +1. Clone the repository: |
| 21 | + ```bash |
| 22 | + git clone https://github.com/stevehangba/hangba.github.io.git |
| 23 | + cd hangba.github.io |
| 24 | + ``` |
16 | 25 |
|
17 | | -- ✅ Tailwind CSS |
18 | | -- ✅ Mobile-first responsive layout |
19 | | -- ✅ Dark and light color mode |
20 | | -- ✅ Custom About, Contact & 404 pages |
21 | | -- ✅ Hero section with short bio |
22 | | -- ✅ Blog content collection |
23 | | -- ✅ Pagination support |
24 | | -- ✅ Tags support for blog posts |
25 | | -- ✅ Subscription form (only UI) |
26 | | -- ✅ View transitions (via swup.js) |
27 | | -- ✅ Sitemap support |
28 | | -- ✅ RSS Feed support |
29 | | -- ✅ Markdown support |
| 26 | +2. Install dependencies: |
| 27 | + ```bash |
| 28 | + pnpm install |
| 29 | + ``` |
30 | 30 |
|
31 | | -### Future Scope (Based on requests) |
| 31 | +3. Start the development server: |
| 32 | + ```bash |
| 33 | + pnpm dev |
| 34 | + ``` |
32 | 35 |
|
33 | | -- ⏹️ MDX support via @astrojs/mdx integration |
34 | | -- ⏹️ SEO-friendly with canonical URLs and OpenGraph data |
35 | | -- ⏹️ New Portfolio/Projects content collection |
36 | | - |
37 | | -## Template Integrations |
38 | | - |
39 | | -- Tailwind v4 via Vite Plugin as per latest Astro docs |
40 | | -- Swup.js for View Transitions |
41 | | -- RSS: [@astrojs/rss](https://docs.astro.build/en/guides/rss/) |
42 | | -- Sitemap: [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/) |
43 | | - |
44 | | -## How to use this template |
45 | | - |
46 | | -### Getting Started |
47 | | - |
48 | | -1. [Create a new repo](https://github.com/new?template_name=space-ahead&template_owner=djsiddz) using this template. |
49 | | -2. Clone to repo to your local computer using `git clone <your-repo-url>`. Then `cd <your-repo-name>`. |
50 | | -3. Setup `pnpm` and use `pnpm install` and then `pnpm dev`. |
51 | | -4. Use the `astro.config.mjs` and `src/site.config.ts` files to setup the template to your liking. |
52 | | -5. Update any content on homepage (`src/pages/index.astro`), about (`src/pages/about.astro`), and contact (`src/pages/contact.astro`). |
53 | | -6. Replace the template posts under (`src/content/blogs/*.md`) with your blog posts, using the same format, with the post metadata. |
54 | | -7. Check the [Astro Deployment guide](https://docs.astro.build/en/guides/deploy/) to know specific steps on deploying this on your preferred provider platform. |
55 | | - |
56 | | -### Project Structure |
57 | | - |
58 | | -You'll see the following folders and files: |
59 | | - |
60 | | -```text |
61 | | -├── public/----------------- Contains the site logo (replace with your own). |
62 | | -├── src/-------------------- |
63 | | -│ ├── assets/------------- Contains svg icons for theme toggle component. |
64 | | -│ │ └── images/--------- Contains default images for homepage and blog posts. |
65 | | -│ ├── components/--------- All Astro/Preact components in this theme. |
66 | | -│ ├── content/------------ Content Collections folder. |
67 | | -│ │ └── blogs/---------- All the blog posts in *.md files. |
68 | | -│ ├── icons/-------------- All Astro icon components. |
69 | | -│ ├── layouts/------------ Shared Layout component. |
70 | | -│ ├── pages/-------------- Various Astro pages, dynamic pages for blogs, tags; a custom 404 page. |
71 | | -│ ├── styles/------------- Contains `global.css`, `fonts.css` and `animate.css`. |
72 | | -│ ├── utils/-------------- Contains helper functions. |
73 | | -│ ├── content.config.ts--- Content collections definitions. |
74 | | -│ ├── env.d.ts------------ Contains helper functions. |
75 | | -│ └── site.config.ts------ Manage your site information and content here. |
76 | | -├── astro.config.mjs-------- Astro configuration file. |
77 | | -├── changelog.md------------ Detailed Changelog for this theme. |
78 | | -├── LICENSE----------------- Theme License. |
79 | | -├── package.json------------ Dependencies and metadata about this template. |
80 | | -├── README.md--------------- 📍 You are here. |
81 | | -└── tsconfig.json----------- Typescript configuration file. |
82 | | -``` |
83 | | - |
84 | | -#### Notes |
85 | | - |
86 | | -- Read & consult [Astro's documentation](https://docs.astro.build/) for up-to-date information and making changes to this template. |
87 | | -- The `src/components` directory is where we like to put any Astro or Preact components. |
88 | | -- The `src/content/` directory contains "collections" of related Markdown (and MDX) documents. Use getCollection() to retrieve posts from `src/content/blogs/`, and type-check your frontmatter using an optional schema. See Astro's [Content Collections](https://docs.astro.build/en/guides/content-collections/) docs to learn more. |
89 | | - |
90 | | -## Credits and Support Info |
91 | | - |
92 | | -### Support Info |
93 | | - |
94 | | -- I provide **paid service** for customizing and setup any of my Astro templates for your projects and startups. Contact me on [Contra](https://contra.com/siddhesht/services) to know more. |
95 | | -- Please feel free to create issues for any bugs or feature requests for this theme. |
96 | | - |
97 | | -### Credits |
98 | | - |
99 | | -- Generated Space Ahead ✨ logo and images for demo blog content using Microsoft Designer. |
100 | | -- Homepage illustration by [Pixeltrue Ouch!](https://icons8.com/illustrations/author/ARh4OKrFtdfC) |
101 | | -- Inspired from these amazing Astro templates - [Dante](https://github.com/JustGoodUI/dante-astro-theme) & [Chiri](https://github.com/the3ash/astro-chiri). Please do check them out. |
102 | | - |
103 | | -## License |
104 | | - |
105 | | -[GNU GPL v3](/LICENSE) |
| 36 | +4. Build for production: |
| 37 | + ```bash |
| 38 | + pnpm build |
| 39 | + ``` |
0 commit comments