Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sma1lboy/sma1lboy.me
personal introduction website
https://github.com/sma1lboy/sma1lboy.me
Last synced: 17 days ago
JSON representation
personal introduction website
- Host: GitHub
- URL: https://github.com/sma1lboy/sma1lboy.me
- Owner: Sma1lboy
- License: mit
- Created: 2023-12-24T06:32:27.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T08:38:21.000Z (29 days ago)
- Last Synced: 2024-10-19T11:36:58.056Z (27 days ago)
- Language: TypeScript
- Homepage: https://sma1lboy.me
- Size: 1.35 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Personal Website Portfolio
This is a customizable personal website portfolio built with Next.js, React, and Tailwind CSS. It features a clean, modern design with easy customization options, GitHub information retrieval, and Markdown-based blog rendering.
## Description
This personal website portfolio allows you to showcase your professional information, GitHub stats, and blog posts in a sleek, responsive design. It's built with modern web technologies and offers easy customization through configuration files.
## Features
- 🎨 Easy theme customization
- 📊 GitHub stats integration
- 📝 Markdown-based blog
- 🚀 Built with Next.js and React
- 🎭 Dark mode support
- 📱 Responsive design
## Configuration
### Site Configuration
To customize the site's basic information and links, edit the `config/site.ts` file:
```typescript
export const siteConfig = {
name: 'Your Name',
description: 'Your description',
links: {
github: 'https://github.com/yourusername',
linkedin: 'https://www.linkedin.com/in/yourusername',
// Add or remove social links as needed
},
// Other configurations...
}
```
### Description
To update the main description on the home page, edit the `config/description.md` file. This file supports Markdown formatting.
### Theme Customization
You can easily change the color scheme by modifying the `colors` object in `config/site.ts`:
```typescript
colors: {
dark: '#9366FF',
light: '#7C3AED',
},
```
### Blog Posts
To add or edit blog posts, simply add or modify Markdown files in the `public/blog` directory. The file name will be used as the URL slug, and you can add a date in the frontmatter:
```markdown
---
Date: 2023-04-01
---
# Your Blog Post Title
Your content here...
```
## Getting Started
1. Clone the repository
2. Install dependencies: `npm install`
3. Run the development server: `npm run dev`
4. Open [http://localhost:3000](http://localhost:3000) in your browser
## Deployment
This project can be easily deployed to platforms like Vercel or Netlify. Refer to their respective documentation for detailed deployment instructions.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.