-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cc1ed47
commit 4858da7
Showing
1 changed file
with
1 addition
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |