docs: Update README with new features and workflow
- Add documentation for build.sh and serve.sh scripts - Document RSS feed feature - Add content management section - Update technology stack information - Improve development workflow instructions
This commit is contained in:
parent
9414e49748
commit
74b1a62ca7
36
README.md
36
README.md
|
|
@ -7,6 +7,8 @@ Visit the live site at [https://glenneth.org](https://glenneth.org)
|
||||||
## Features
|
## Features
|
||||||
- Responsive design optimized for all devices
|
- Responsive design optimized for all devices
|
||||||
- Clean, modern UI with subtle animations
|
- Clean, modern UI with subtle animations
|
||||||
|
- RSS feed support for blog posts
|
||||||
|
- Markdown-to-HTML conversion for content
|
||||||
- Dedicated sections for:
|
- Dedicated sections for:
|
||||||
- Technical blog posts
|
- Technical blog posts
|
||||||
- Travel stories
|
- Travel stories
|
||||||
|
|
@ -18,7 +20,9 @@ Visit the live site at [https://glenneth.org](https://glenneth.org)
|
||||||
- HTML5
|
- HTML5
|
||||||
- CSS (Tailwind CSS for styling)
|
- CSS (Tailwind CSS for styling)
|
||||||
- JavaScript
|
- JavaScript
|
||||||
- Static site generation capabilities
|
- Node.js for build tools
|
||||||
|
- Live-server for development
|
||||||
|
- Static site generation with markdown support
|
||||||
|
|
||||||
## Local Development
|
## Local Development
|
||||||
1. Clone this repository
|
1. Clone this repository
|
||||||
|
|
@ -28,8 +32,36 @@ Visit the live site at [https://glenneth.org](https://glenneth.org)
|
||||||
```
|
```
|
||||||
3. Start the development server:
|
3. Start the development server:
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
./serve.sh
|
||||||
```
|
```
|
||||||
|
This will start a live-server instance with auto-reload on port 3001.
|
||||||
|
|
||||||
|
## Content Management
|
||||||
|
### Adding New Blog Posts
|
||||||
|
1. Create a new markdown file in `content/posts/`
|
||||||
|
2. Include frontmatter with title, date, and tags:
|
||||||
|
```markdown
|
||||||
|
---
|
||||||
|
title: Your Post Title
|
||||||
|
author: Glenn Thompson
|
||||||
|
date: YYYY-MM-DD HH:MM
|
||||||
|
tags: tech, programming, travel
|
||||||
|
---
|
||||||
|
```
|
||||||
|
3. Run the build script to convert markdown to HTML:
|
||||||
|
```bash
|
||||||
|
./build.sh
|
||||||
|
```
|
||||||
|
This will:
|
||||||
|
- Convert any new or modified markdown files to HTML
|
||||||
|
- Update the RSS feed
|
||||||
|
- Generate the deployment package
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
The site is deployed as a static website. Run `./deploy.sh` to create a deployment package.
|
||||||
|
|
||||||
|
## RSS Feed
|
||||||
|
An RSS feed is available at `/feed.xml` for subscribing to blog updates.
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
For any inquiries, please reach out to [glenn@glenneth.org](mailto:glenn@glenneth.org)
|
For any inquiries, please reach out to [glenn@glenneth.org](mailto:glenn@glenneth.org)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue