Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
metaboulie committed Dec 27, 2024
1 parent cc1ed47 commit 4858da7
Showing 1 changed file with 1 addition and 74 deletions.
75 changes: 1 addition & 74 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,3 @@
# Personal Portfolio & Blog

A modern, minimalist portfolio and blog built with SvelteKit, TypeScript, MDSvex, and Tailwind CSS.

## Features

- πŸš€ Built with SvelteKit 5 and TypeScript
- πŸ“ Blog with MDSvex for Markdown processing
- πŸ’… Styled with Tailwind CSS and Typography plugin
- 🎨 Dark theme with Nord-inspired colors
- ✨ Syntax highlighting with Shiki
- πŸ“± Fully responsive design
- πŸ”„ Automatic deployment to GitHub Pages

## Development

### Prerequisites

- Node.js 20 or later
- npm or pnpm

### Setup

1. Clone the repository:

```bash
git clone https://github.com/yourusername/portfolio.git
cd portfolio
```

2. Install dependencies:

```bash
npm install
# or
pnpm install
```

3. Start the development server:

```bash
npm run dev
# or
pnpm dev
```

4. Open http://localhost:5173 in your browser

### Adding Blog Posts

1. Create a new markdown file in `src/content/blog/`
2. Add frontmatter metadata at the top of the file:
```markdown
---
title: Your Post Title
date: '2023-12-27'
description: A brief description of your post
---
```
3. Write your post content in Markdown

### Building for Production

```bash
npm run build
# or
pnpm build
```

### Deployment

The site is automatically deployed to GitHub Pages when changes are pushed to the main branch.

## License

MIT
A minimalist portfolio and blog built with SvelteKit, TypeScript, MDSvex, and Tailwind CSS.

0 comments on commit 4858da7

Please sign in to comment.