From 74b1a62ca7c3beefe431ed6ded7a911578501e2a Mon Sep 17 00:00:00 2001 From: glenneth1 Date: Tue, 3 Dec 2024 06:33:43 +0300 Subject: [PATCH] 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 --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b173dce..afc15d0 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ Visit the live site at [https://glenneth.org](https://glenneth.org) ## Features - Responsive design optimized for all devices - Clean, modern UI with subtle animations +- RSS feed support for blog posts +- Markdown-to-HTML conversion for content - Dedicated sections for: - Technical blog posts - Travel stories @@ -18,7 +20,9 @@ Visit the live site at [https://glenneth.org](https://glenneth.org) - HTML5 - CSS (Tailwind CSS for styling) - JavaScript -- Static site generation capabilities +- Node.js for build tools +- Live-server for development +- Static site generation with markdown support ## Local Development 1. Clone this repository @@ -28,8 +32,36 @@ Visit the live site at [https://glenneth.org](https://glenneth.org) ``` 3. Start the development server: ```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 For any inquiries, please reach out to [glenn@glenneth.org](mailto:glenn@glenneth.org)