merge in new changes
This commit is contained in:
79
README.md
79
README.md
@@ -1,74 +1,31 @@
|
||||
# Alex Lebens Personal Site
|
||||
# This is an open-source and simple blog built with Astro.
|
||||
|
||||
Personal site used for information about myself and blog.
|
||||
|
||||
## Features
|
||||
|
||||
- 🚀 **Maximum Performance** - Built with Astro.js for lightning-fast static sites
|
||||
- 🎨 **Minimalist Design** - Clean UI that focuses on content
|
||||
- 🌓 **Light/Dark Mode** - Smooth theme switching
|
||||
- 📱 **Responsive** - Perfect experience on all devices
|
||||
- ⚡ **SPA Transitions** - Smooth page navigation with transition effects
|
||||
- 📝 **Markdown & MDX** - Write posts with Markdown and extend with MDX
|
||||
- 🔍 **SEO Optimized** - Meta tags, Open Graph, and Twitter Cards
|
||||
- 📊 **Analytics** - Reading time, views, and statistics
|
||||
- 🔖 **Categorization** - Tags and categories system
|
||||
- 🔄 **RSS Feed** - Automatically generated RSS feed
|
||||
- 🌐 **Internationalization Ready** - Prepared for multiple languages
|
||||
- 🔒 **Secure** - No unnecessary client-side JavaScript
|
||||
- 🐈 Simple And Beautiful
|
||||
- 🖥️️ Responsive And Light/Dark mode
|
||||
- 🐛 SiteMap & RSS Feed
|
||||
- 🐝 Category Support
|
||||
- 🐜 SEO and Responsiveness
|
||||
- 🪲 Markdown And MDX
|
||||
- 🏂🏾 Page Compression & Image Optimization
|
||||
|
||||
## Getting Started
|
||||
### Development Commands
|
||||
|
||||
### Requirements
|
||||
With dependencies installed, you can utilize the following npm scripts to manage your project's development lifecycle:
|
||||
|
||||
- Node.js 22+ and pnpm
|
||||
- `pnpm run dev`: Starts a local development server with hot reloading enabled.
|
||||
- `pnpm run preview`: Serves your build output locally for preview before deployment.
|
||||
- `pnpm run build`: Bundles your site into static files for production.
|
||||
|
||||
### Installation
|
||||
For detailed help with Astro CLI commands, visit [Astro's documentation](https://docs.astro.build/en/reference/cli-reference/).
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://gitea.alexlebens.dev/alexlebens/site-profile
|
||||
## Thanks
|
||||
|
||||
# Navigate to project directory
|
||||
cd site-profile
|
||||
Thanks https://github.com/mearashadowfax/ScrewFast, https://github.com/godruoyi/gblog/tree/gblog-template
|
||||
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
## License
|
||||
|
||||
```
|
||||
|
||||
### Development
|
||||
|
||||
```bash
|
||||
# Start development server
|
||||
pnpm dev
|
||||
|
||||
# Open browser at http://localhost:4321
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
# Create production build
|
||||
pnpm build
|
||||
|
||||
# Preview production build
|
||||
pnpm preview
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
/
|
||||
├── public/ # Static assets
|
||||
├── src/
|
||||
│ ├── components/ # Reusable UI components
|
||||
│ ├── content/ # Blog content (Markdown/MDX)
|
||||
│ ├── layouts/ # Page layouts
|
||||
│ ├── pages/ # Pages and routes
|
||||
│ ├── styles/ # CSS and Tailwind
|
||||
│ └── utils/ # Utilities and helpers
|
||||
├── astro.config.mjs # Astro configuration
|
||||
├── tailwind.config.js # Tailwind configuration
|
||||
└── tsconfig.json # TypeScript configuration
|
||||
```
|
||||
This project is released under the MIT License. Please read the [LICENSE](https://gitea.alexlebens.dev/alexlebens/site-profile/src/LICENSE.md) file for more details.
|
||||
|
Reference in New Issue
Block a user