review changes

Author: gildesmarais

.github/workflows/lint.yml

@@ -25,4 +25,4 @@ jobs:
         run: npm ci
 
       - name: Run linters
-        run: npm run lint
+        run: make lint

.prettierrc.json

@@ -1,10 +1,22 @@
-default: setup clean lintfix serve
+default: setup clean lintfix dev
 
 setup:
 	npm ci
 	bundle check || bundle
 	make update
 
+dev:
+	npm run dev
+
+build:
+	npm run build
+
+preview:
+	npm run preview
+
+build-full:
+	npm run build:full
+
 lint:
 	npm run lint
 
@@ -18,6 +30,3 @@ clean:
 update:
 	bundle update html2rss-configs
 	bin/data-update
-
-serve: setup
-	bundle exec jekyll s --drafts --trace

Makefile

@@ -1,187 +1,49 @@
-# html2rss Documentation
+# html2rss.github.io
 
-The official documentation website for html2rss, built with Astro Starlight for modern performance and developer experience.
+This repository hosts the documentation and website for `html2rss`, a tool for creating RSS feeds from any
+website.
 
-## 🚀 Features
-
-- **Modern Documentation**: Built with Astro Starlight for better performance and developer experience
-- **Interactive Feed Directory**: Fully functional with search, filtering, and parameter configuration
-- **Progressive Enhancement**: Works without JavaScript, enhanced with Alpine.js
-- **Dark Theme**: Integrated with Starlight's theme system
-- **GitHub Integration**: Edit links and social links
-- **Analytics**: GoatCounter integration
-- **SEO Optimized**: Meta tags, sitemap, and search indexing
-
-## 📁 Project Structure
-
-```
-html2rss.github.io/
-├── src/
-│   ├── content/docs/          # Documentation content (MDX)
-│   ├── components/            # Astro components
-│   │   └── FeedDirectory.astro # Interactive feed directory
-│   ├── data/                  # Data files
-│   │   ├── configs.json       # Generated feed configurations
-│   │   └── loadConfigs.ts     # Data loader
-│   └── assets/                # Static assets
-├── bin/
-│   └── data-update            # Script to update feed data
-├── public/                    # Public assets
-├── .github/workflows/         # CI/CD workflows
-└── Gemfile                    # Ruby dependencies for data updates
-```
-
-## 🛠️ Development
+## 🚀 Getting Started (Developers)
 
 ### Prerequisites
 
-- Node.js 22+
-- Ruby 3.3+
-- npm/yarn
-
-### Setup
-
-1. **Install Node.js dependencies:**
-   ```bash
-   npm install
-   ```
-
-2. **Install Ruby dependencies:**
-   ```bash
-   bundle install
-   ```
-
-3. **Update feed data:**
-   ```bash
-   npm run update-data
-   ```
-
-4. **Start development server:**
-   ```bash
-   npm run dev
-   ```
-
-### Available Scripts
-
-- `npm run dev` - Start development server
-- `npm run build` - Build for production
-- `npm run preview` - Preview production build
-- `npm run update-data` - Update feed configurations from html2rss-configs
-- `npm run build:full` - Update data and build
-
-## 📊 Data Management
-
-The feed directory data is automatically generated from the `html2rss-configs` gem:
-
-1. **Source**: `html2rss-configs` gem (latest commit from GitHub)
-2. **Generation**: `bin/data-update` script processes the gem's configs
-3. **Output**: `src/data/configs.json` (clean JSON format)
-4. **Usage**: Loaded by `src/data/loadConfigs.ts` in the FeedDirectory component
-
-### Data Update Process
-
-The `bin/data-update` script:
-- Fetches all config files from the `html2rss-configs` gem
-- Extracts metadata (domain, name, parameters, etc.)
-- Converts to clean JSON format (no parsing issues)
-- Generates `src/data/configs.json`
-
-## 🚀 Deployment
+- Node.js (for Astro)
+- Ruby (for data updates)
 
-### GitHub Pages (CI/CD)
-
-The site is automatically deployed via GitHub Actions:
-
-1. **Trigger**: Push to `main` branch
-2. **Process**:
-   - Install Ruby dependencies
-   - Run `bin/data-update` to update feed data
-   - Install Node.js dependencies
-   - Build Astro site
-   - Deploy to GitHub Pages
-
-### Manual Deployment
+### Quick Setup
 
 ```bash
-# Update data and build
-npm run build:full
-
-# Deploy the dist/ folder to your hosting provider
+# Install dependencies and start development server
+make setup
 ```
 
-## 🔧 Configuration
-
-### Astro Configuration
-
-Key settings in `astro.config.mjs`:
-- Site URL and base path
-- Starlight integration with custom head elements
-- GitHub social links and edit URLs
-- Sidebar navigation structure
-
-### Feed Directory
-
-The interactive Feed Directory (`src/components/FeedDirectory.astro`):
-- Uses Alpine.js for interactivity
-- Loads data from `src/data/configs.yml`
-- Provides search and filtering
-- Shows parameter forms for dynamic feeds
-- Generates RSS URLs and GitHub edit links
-
-## 📝 Content Migration
-
-All content has been migrated from Jekyll to Astro Starlight:
-
-- **Markdown → MDX**: Converted all `.md` files to `.mdx`
-- **Frontmatter**: Updated to Starlight format
-- **URLs**: Updated relative links
-- **Images**: Migrated to `public/assets/images/`
-- **Components**: Recreated Jekyll components as Astro components
-
-## 🎨 Styling
-
-- **Theme**: Uses Starlight's built-in theme system
-- **Colors**: HSL color variables for dark/light mode compatibility
-- **Components**: Custom CSS for Feed Directory integrated with Starlight
-- **Responsive**: Mobile-friendly design
-
-## 🔍 Search
-
-- **Engine**: Pagefind (integrated with Starlight)
-- **Indexing**: Automatic during build
-- **Features**: Full-text search across all documentation
-
-## 📈 Analytics
-
-- **Provider**: GoatCounter
-- **Integration**: Script added to `astro.config.mjs`
-- **Privacy**: No cookies, GDPR compliant
-
-## 🐛 Troubleshooting
-
-### Common Issues
+### Available Commands
 
-1. **Data not loading**: Run `npm run update-data` to regenerate configs
-2. **Build errors**: Check for JSON syntax issues in generated data
-3. **Styling issues**: Ensure CSS uses Starlight's color variables
+- `make setup` - Install dependencies and start dev server
+- `make dev` - Start Astro development server
+- `make build` - Build for production
+- `make preview` - Preview production build
+- `make build-full` - Update data and build for production
+- `make lintfix` - Fix code formatting
+- `make update` - Update feed data
 
-### Development Tips
+## 🌐 Community & Resources
 
-- Use `npm run build:full` to test the complete build process
-- Check `src/data/configs.json` for data issues
-- Use browser dev tools to debug Alpine.js components
+| Resource                              | Description                                                 | Link                                                               |
+| ------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------ |
+| **📚 Documentation & Feed Directory** | Complete guides, tutorials, and browse 100+ pre-built feeds | [html2rss.github.io](https://html2rss.github.io)                   |
+| **💬 Community Discussions**          | Get help, share ideas, and connect with other users         | [GitHub Discussions](https://github.com/orgs/html2rss/discussions) |
+| **📋 Project Board**                  | Track development progress and upcoming features            | [View Project Board](https://github.com/orgs/html2rss/projects)    |
+| **💖 Support Development**            | Help fund ongoing development and maintenance               | [Sponsor on GitHub](https://github.com/sponsors/gildesmarais)      |
 
-## 📚 Migration Notes
+**Quick Start Options:**
 
-This migration preserves all functionality from the original Jekyll site:
+- **New to RSS?** → Start with the [web application](https://html2rss.github.io/web-application)
+- **Ruby Developer?** → Check out the [Ruby gem documentation](https://html2rss.github.io/ruby-gem)
+- **Need a specific feed?** → Browse the [feed directory](https://html2rss.github.io/feed-directory)
+- **Want to contribute?** → See our [contributing guide](https://html2rss.github.io/get-involved/contributing)
 
-- ✅ All content migrated
-- ✅ Feed Directory fully functional
-- ✅ Search and navigation working
-- ✅ GitHub integration maintained
-- ✅ Analytics preserved
-- ✅ SEO optimization maintained
-- ✅ Progressive enhancement working
-- ✅ Dark theme support
+## Contributing
 
-The new Astro Starlight version provides better performance, modern tooling, and improved developer experience while maintaining full backward compatibility.
+Contributions are welcome! See our [Get Involved page](https://html2rss.github.io/get-involved) for details on
+discussions, reporting issues, and contributing.

README.md

@@ -59,7 +59,6 @@ end
 config_file = File.join(__dir__, '..', 'src/data/configs.json')
 FileUtils.touch config_file
 
-# Convert to JSON (no Ruby-specific tags to clean up)
 json_content = JSON.pretty_generate(output)
 
 File.write(config_file, json_content)

bin/data-update

@@ -10,8 +10,8 @@
     "astro": "astro",
     "update-data": "ruby bin/data-update",
     "build:full": "npm run update-data && npm run build",
-    "lint": "prettier --check 'src/**/*.{astro,js,ts,jsx,tsx,css,scss,md,mdx}'",
-    "lintfix": "prettier --write 'src/**/*.{astro,js,ts,jsx,tsx,css,scss,md,mdx}'"
+    "lint": "prettier --check .",
+    "lintfix": "prettier --write ."
   },
   "dependencies": {
     "@astrojs/starlight": "^0.35.3",

package.json

@@ -0,0 +1,34 @@
+/** @type {import("prettier").Config} */
+export default {
+  // Global settings
+  printWidth: 110,
+  singleQuote: false,
+  trailingComma: 'all',
+  plugins: ['prettier-plugin-astro'],
+
+  // File-specific overrides
+  overrides: [
+    {
+      // Astro files need special parser
+      files: '*.astro',
+      options: {
+        parser: 'astro',
+      },
+    },
+    {
+      // Markdown and prose files should preserve natural line breaks
+      files: '*.{html,md,mdx}',
+      options: {
+        proseWrap: 'preserve', // Don't force rewrapping of prose content
+      },
+    },
+    {
+      // JavaScript/TypeScript files use single quotes and ES5 trailing commas
+      files: '*.{js,ts,jsx,tsx}',
+      options: {
+        singleQuote: true,
+        trailingComma: 'es5',
+      },
+    },
+  ],
+};

prettier.config.js

@@ -59,7 +59,6 @@ Optimize requests with appropriate headers:
 headers:
   Accept: "text/html,application/xhtml+xml" # Avoid JSON if not needed
   Accept-Encoding: "gzip, deflate" # Enable compression
-  User-Agent: "html2rss/1.0" # Identify your requests
 ```
 
 ## Monitoring and Debugging