Merge pull request #43 from hackmdio/chore/progress-resume-example

examples(book-mode-conference): add progress/resume support

Author: Yukaii

examples/book-mode-conference/.env.example

@@ -1,8 +1,49 @@
-# HackMD API Configuration
-# Get your access token from: https://hackmd.io/@hackmd-api/developer-portal
+# HackMD Conference Note Generation Environment Variables
 
-# Required: Your HackMD access token
+# Required: HackMD API Access Token
+# Get this from your HackMD instance settings > API tokens
+# For hackmd.io: https://hackmd.io/@hackmd-api/developer-portal
 HACKMD_ACCESS_TOKEN=your_access_token_here
 
-# Optional: HackMD API endpoint (defaults to https://api.hackmd.io/v1)
-HACKMD_API_ENDPOINT=https://api.hackmd.io/v1
+# Required: HackMD API Endpoint URL
+# For hackmd.io: https://api.hackmd.io/v1
+# For self-hosted: https://your-hackmd-instance.com/api/v1
+HACKMD_API_ENDPOINT=https://api.hackmd.io/v1
+
+# Optional: HackMD Web Domain (for generating correct note URLs)
+# This is useful when your API endpoint differs from the web domain
+# For hackmd.io: https://hackmd.io
+# For self-hosted: https://your-hackmd-instance.com
+# If not set, defaults to the API endpoint
+HACKMD_WEB_DOMAIN=https://hackmd.io
+
+# Optional: Test Mode
+# Set to 'true' to create limited notes for testing
+# Set to 'false' or omit for full note generation
+TEST_MODE=false
+
+# Optional: Resume Mode
+# Set to 'true' to resume from previous interrupted execution
+# Set to 'false' or omit for fresh generation
+RESUME_MODE=false
+
+# Optional: Fixed delay (milliseconds) between API requests
+# Use to avoid rate limits in production environments
+# Can also be set via --delay-ms CLI flag
+# Recommended: 200-500ms for production
+REQUEST_DELAY_MS=0
+
+# Example configurations:
+# 
+# For hackmd.io:
+# HACKMD_API_ENDPOINT=https://api.hackmd.io/v1
+# HACKMD_WEB_DOMAIN=https://hackmd.io
+#
+# For self-hosted HackMD:
+# HACKMD_API_ENDPOINT=https://your-hackmd.example.com/api/v1
+# HACKMD_WEB_DOMAIN=https://your-hackmd.example.com
+#
+# Production environment example:
+# TEST_MODE=false
+# REQUEST_DELAY_MS=300
+# RESUME_MODE=false