markdown-slides-cli 1.0.4 → 1.0.6

package/README.md

@@ -1,6 +1,6 @@
 # 📊 Markdown Slides
 
-> A powerful, interactive markdown slide presentation tool with live editing, minimap view, and fullscreen support. Create beautiful presentations from simple markdown files!
+> A powerful, interactive markdown slide presentation tool with live editing, minimap view, and fullscreen and stdin support. Create beautiful presentations from simple markdown files!
 
 ![Node.js](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)
 ![License](https://img.shields.io/badge/license-MIT-green)
@@ -8,6 +8,7 @@
 ## ✨ Features
 
 - 📝 **Markdown-Based** - Write slides in simple markdown syntax
+- 🎯 **Flexible Input** - Load from files or stdin (pipe support)
 - 🗺️ **Minimap View** - Navigate slides with thumbnail overview
 - ✏️ **Live Editor** - Built-in Monaco editor (VS Code's editor)
 - 🎨 **Beautiful Rendering** - Full markdown support with syntax highlighting
@@ -59,9 +60,12 @@ function hello() {
   console.log('Hello World!');
 }
 ```
+```
 
 ### 2. Run the Presentation
 
+**From a file:**
+
 ```bash
 node markdown-slides.js -f slides.md
 ```
@@ -72,13 +76,35 @@ Or with global installation:
 markdown-slides -f slides.md
 ```
 
+**From stdin (pipe):**
+
+```bash
+# Pipe from a file
+cat slides.md | markdown-slides
+
+# Pipe from echo
+echo "# Slide 1\n---\n# Slide 2" | markdown-slides
+
+# Using heredoc
+markdown-slides << EOF
+# Welcome
+This is my presentation
+---
+# Second Slide
+More content here
+EOF
+
+# Combine with other commands
+curl https://raw.githubusercontent.com/user/repo/main/slides.md | markdown-slides
+```
+
 Your browser will automatically open with your presentation!
 
 ## 🎮 CLI Options
 
 | Option | Alias | Description | Default |
 |--------|-------|-------------|---------|
-| `--file` | `-f` | Markdown file path (required) | - |
+| `--file` | `-f` | Markdown file path (optional if using stdin) | - |
 | `--port` | `-p` | Server port | `3457` |
 | `--title` | `-t` | Presentation title | `Markdown Slides` |
 | `--theme` | - | Slide theme (dark/light/blue) | `dark` |
@@ -86,6 +112,8 @@ Your browser will automatically open with your presentation!
 
 ### Examples
 
+**File-based:**
+
 ```bash
 # Basic usage
 markdown-slides -f presentation.md
@@ -97,6 +125,22 @@ markdown-slides -f slides.md -p 8080 -t "My Presentation"
 markdown-slides -f deck.md --theme blue
 ```
 
+**Stdin-based:**
+
+```bash
+# From pipe
+cat slides.md | markdown-slides
+
+# With options
+cat slides.md | markdown-slides -p 8080 -t "My Talk"
+
+# From command output
+generate-slides.sh | markdown-slides
+
+# From URL
+curl https://example.com/slides.md | markdown-slides
+```
+
 ## ⌨️ Keyboard Shortcuts
 
 | Key | Action |
@@ -297,9 +341,7 @@ curl -H "Authorization: Bearer TOKEN" /api/users
 
 ---
 
-#
-
-### Technologies Used
+# Technologies Used
 
 - **Node.js** - Runtime environment
 - **Commander** - CLI argument parsing
@@ -315,6 +357,8 @@ curl -H "Authorization: Bearer TOKEN" /api/users
 - 📖 **Documentation** - Product demos, guides
 - 👨‍🏫 **Training Materials** - Workshops, courses
 - 📊 **Data Presentations** - Reports with code examples
+- 🔄 **Dynamic Content** - Generate slides from scripts and pipe to viewer
+- 🌐 **Remote Content** - Fetch and present markdown from URLs
 
 ## 💡 Tips & Tricks
 
@@ -337,6 +381,28 @@ curl -H "Authorization: Bearer TOKEN" /api/users
 
 ### Advanced Usage
 
+**Stdin Input**: Pipe markdown directly without creating files
+```bash
+cat slides.md | markdown-slides -p 3000
+```
+
+**Dynamic Generation**: Combine with other tools
+```bash
+# Generate slides from a script
+./generate-report.sh | markdown-slides
+
+# Fetch from URL
+curl https://example.com/slides.md | markdown-slides
+
+# Use with heredoc for quick presentations
+markdown-slides << 'EOF'
+# Quick Demo
+This is a quick presentation
+---
+# Thank You!
+EOF
+```
+
 **Custom Styling**: Edit the embedded CSS in `markdown-slides.js`
 
 **Custom Themes**: Modify the color scheme in the `<style>` section
@@ -371,6 +437,17 @@ markdown-slides -f slides.md -p 8080
 - Check for proper slide separators (`---`)
 - Verify file encoding is UTF-8
 
+### No Input Provided Error
+
+```bash
+# Either provide a file
+markdown-slides -f slides.md
+
+# Or pipe content via stdin
+cat slides.md | markdown-slides
+echo "# Slide" | markdown-slides
+```
+
 ## 📋 Requirements
 
 - Node.js >= 14.0.0
@@ -396,14 +473,10 @@ All other features (Marked, Monaco Editor, Tailwind CSS) load from CDNs.
 - [ ] Video embed support
 - [ ] Auto-save functionality
 
-
-
 ## 📝 License
 
 MIT License (c) Mohan Chinnappan
 
-
-
 ---
 
 ## 📚 Quick Reference Card
@@ -414,6 +487,7 @@ MIT License (c) Mohan Chinnappan
 ├─────────────────────────────────────────┤
 │ Start Server:                           │
 │   markdown-slides -f slides.md          │
+│   cat slides.md | markdown-slides       │
 │                                         │
 │ Keyboard Shortcuts:                     │
 │   → / Space     Next slide              │

package/index.js

@@ -12,7 +12,7 @@ const { exec } = require('child_process');
 program
   .name('markdown-slides')
   .description('Interactive markdown slide presentation with live editing')
-  .requiredOption('-f, --file <path>', 'markdown file with slides')
+  .option('-f, --file <path>', 'markdown file with slides')
   .option('-p, --port <number>', 'server port', '3457')
   .option('-t, --title <title>', 'presentation title', 'Markdown Slides')
   .option('--theme <theme>', 'slide theme: dark, light, blue', 'dark')
@@ -20,20 +20,62 @@ program
 
 const opts = program.opts();
 
-// Validate markdown file
-if (!fs.existsSync(opts.file)) {
-  console.error(`Error: File not found: ${opts.file}`);
-  process.exit(1);
+async function readStdin() {
+  return new Promise((resolve, reject) => {
+    let data = '';
+    process.stdin.setEncoding('utf8');
+    process.stdin.on('data', chunk => (data += chunk));
+    process.stdin.on('end', () => resolve(data));
+    process.stdin.on('error', reject);
+  });
 }
 
-const markdownContent = fs.readFileSync(opts.file, 'utf-8');
-const fileName = path.basename(opts.file);
+async function getMarkdownContent() {
+  // Check if stdin has data (piped input)
+  const isStdin = !process.stdin.isTTY;
+  
+  if (opts.file) {
+    // File was provided
+    if (!fs.existsSync(opts.file)) {
+      console.error(`Error: File not found: ${opts.file}`);
+      process.exit(1);
+    }
+    return {
+      content: fs.readFileSync(opts.file, 'utf-8'),
+      fileName: path.basename(opts.file),
+      source: 'file'
+    };
+  } else if (isStdin) {
+    // Read from stdin
+    const content = await readStdin();
+    if (!content.trim()) {
+      console.error('Error: No content provided via stdin');
+      process.exit(1);
+    }
+    return {
+      content,
+      fileName: 'slides.md',
+      source: 'stdin'
+    };
+  } else {
+    // No input provided
+    console.error('Error: No input provided. Use -f <file> or pipe markdown content.');
+    console.error('\nExamples:');
+    console.error('  markdown-slides -f presentation.md');
+    console.error('  cat slides.md | markdown-slides');
+    console.error('  echo "# Slide 1\\n---\\n# Slide 2" | markdown-slides');
+    process.exit(1);
+  }
+}
+
+async function main() {
+  const { content: markdownContent, fileName, source } = await getMarkdownContent();
 
-console.log(`\n📊 Markdown Slides Viewer`);
-console.log(`File: ${fileName}`);
-console.log(`\n🌐 Starting server on http://localhost:${opts.port}`);
+  console.log(`\n📊 Markdown Slides Viewer`);
+  console.log(`Source: ${source === 'file' ? fileName : 'stdin'}`);
+  console.log(`\n🌐 Starting server on http://localhost:${opts.port}`);
 
-const html = `<!DOCTYPE html>
+  const html = `<!DOCTYPE html>
 <html lang="en" class="dark">
 <head>
   <meta charset="UTF-8">
@@ -469,36 +511,42 @@ const html = `<!DOCTYPE html>
 </body>
 </html>`;
 
-// Create HTTP server
-const server = http.createServer((req, res) => {
-  if (req.url === '/') {
-    res.writeHead(200, { 'Content-Type': 'text/html' });
-    res.end(html);
-  } else {
-    res.writeHead(404);
-    res.end('Not Found');
-  }
-});
+  // Create HTTP server
+  const server = http.createServer((req, res) => {
+    if (req.url === '/') {
+      res.writeHead(200, { 'Content-Type': 'text/html' });
+      res.end(html);
+    } else {
+      res.writeHead(404);
+      res.end('Not Found');
+    }
+  });
 
-server.listen(opts.port, () => {
-  const url = `http://localhost:${opts.port}`;
-  console.log(`✅ Server running at ${url}\n`);
-  
-  // Open browser
-  const command = process.platform === 'darwin' ? 'open' : 
-                  process.platform === 'win32' ? 'start' : 'xdg-open';
-  exec(`${command} ${url}`, (err) => {
-    if (err) console.log('Please open the URL manually in your browser');
+  server.listen(opts.port, () => {
+    const url = `http://localhost:${opts.port}`;
+    console.log(`✅ Server running at ${url}\n`);
+    
+    // Open browser
+    const command = process.platform === 'darwin' ? 'open' : 
+                    process.platform === 'win32' ? 'start' : 'xdg-open';
+    exec(`${command} ${url}`, (err) => {
+      if (err) console.log('Please open the URL manually in your browser');
+    });
+
+    console.log('Press Ctrl+C to stop the server\n');
+    console.log('Keyboard shortcuts:');
+    console.log('  → / Space    Next slide');
+    console.log('  ←            Previous slide');
+    console.log('  Home         First slide');
+    console.log('  End          Last slide');
+    console.log('  F / F11      Fullscreen');
+    console.log('  E            Open editor');
+    console.log('  M            Toggle minimap');
+    console.log('  ESC          Close editor');
   });
+}
 
-  console.log('Press Ctrl+C to stop the server\n');
-  console.log('Keyboard shortcuts:');
-  console.log('  → / Space    Next slide');
-  console.log('  ←            Previous slide');
-  console.log('  Home         First slide');
-  console.log('  End          Last slide');
-  console.log('  F / F11      Fullscreen');
-  console.log('  E            Open editor');
-  console.log('  M            Toggle minimap');
-  console.log('  ESC          Close editor');
+main().catch(err => {
+  console.error('Error:', err.message);
+  process.exit(1);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-slides-cli",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Interactive markdown slide presentation with live editing and minimap view",
   "main": "index.js",
   "publisher": "mohanchinnappan",