create-marp-presentation 1.0.1 → 1.1.0

package/README.md

@@ -1,14 +1,14 @@
 # Create Marp Presentation
 
-Создайте новую Marp презентацию одной командой.
+Create a new Marp presentation with a single command.
 
-## Установка
+## Installation
 
 ```bash
 npx create-marp-presentation my-presentation
 ```
 
-## Использование
+## Usage
 
 ```bash
 cd my-presentation
@@ -16,7 +16,7 @@ npm run dev     # Live preview
 npm run build:all  # Build all formats
 ```
 
-## Возможности
+## Features
 
 - 🚀 One-command setup
 - 📝 Markdown slides
@@ -25,10 +25,41 @@ npm run build:all  # Build all formats
 - 📁 Static files support
 - 🔥 Live preview
 
-## Документация
+## Local Testing
 
-После создания проекта читайте README в папке проекта.
+To test project generation without publishing to npm:
 
-## Лицензия
+```bash
+# Clone the repository
+git clone https://github.com/echernyshev/marp-presentation-template.git
+cd marp-presentation-template
+
+# Install dependencies for tests
+npm install
+
+# Run tests
+npm test
+
+# Create a test project (interactive mode)
+node index.js test-project
+
+# Check the contents
+cd test-project
+ls -la
+npm run dev
+```
+
+Other example commands:
+
+```bash
+# Create a test project without examples
+echo "n" | node index.js test-project-minimal
+```
+
+## Documentation
+
+After creating a project, read the README in the project folder.
+
+## License
 
 MIT

package/index.js

@@ -3,6 +3,7 @@
 const fs = require('fs');
 const path = require('path');
 const { spawnSync } = require('child_process');
+const readline = require('readline');
 
 const projectName = process.argv[2];
 
@@ -22,6 +23,57 @@ if (!validName.test(projectName)) {
 
 const projectPath = path.join(process.cwd(), projectName);
 
+// Запрос на создание примеров слайдов
+async function askCreateExamples() {
+  return new Promise((resolve) => {
+    // Интерактивный режим — спрашиваем пользователя
+    if (process.stdin.isTTY) {
+      const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+      });
+
+      rl.question('Create example slides file? (Y/n) ', (answer) => {
+        rl.close();
+        const normalized = answer.toLowerCase().trim();
+        resolve(normalized !== 'n' && normalized !== 'no');
+      });
+    } else {
+      // Неинтерактивный режим — читаем из stdin если есть данные
+      let input = '';
+      process.stdin.setEncoding('utf8');
+
+      process.stdin.on('readable', () => {
+        let chunk;
+        while ((chunk = process.stdin.read()) !== null) {
+          input += chunk;
+        }
+      });
+
+      process.stdin.on('end', () => {
+        const normalized = input.toLowerCase().trim();
+        // Если ввод пустой, создаём примеры по умолчанию
+        if (normalized === '') {
+          resolve(true);
+        } else {
+          resolve(normalized !== 'n' && normalized !== 'no');
+        }
+      });
+
+      // Если stdin не имеет данных сразу, завершаем
+      if (process.stdin.readableLength === 0) {
+        // Даем небольшое время на появление данных
+        setTimeout(() => {
+          if (input === '') {
+            process.stdin.destroy();
+            resolve(true);
+          }
+        }, 10);
+      }
+    }
+  });
+}
+
 // Validate path to prevent traversal attacks
 const resolvedPath = path.resolve(projectPath);
 if (!resolvedPath.startsWith(path.resolve(process.cwd()))) {
@@ -38,59 +90,95 @@ if (fs.existsSync(projectPath)) {
 // Получаем путь к template
 const templatePath = path.join(__dirname, 'template');
 
+// Рекурсивное копирование директории
+const copyDir = (src, dest) => {
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      fs.mkdirSync(destPath, { recursive: true });
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+};
+
+// Копирование опциональных файлов
+const copyOptionalFiles = (destPath) => {
+  const optionalPath = path.join(__dirname, 'template-optional');
+
+  // Копируем examples.md
+  const examplesSrc = path.join(optionalPath, 'examples.md');
+  const examplesDest = path.join(destPath, 'examples.md');
+  if (fs.existsSync(examplesSrc)) {
+    fs.copyFileSync(examplesSrc, examplesDest);
+  }
+
+  // Копируем демо-изображение
+  const demoImageSrc = path.join(optionalPath, 'static', 'demo-image.png');
+  const demoImageDest = path.join(destPath, 'static', 'demo-image.png');
+  if (fs.existsSync(demoImageSrc)) {
+    fs.copyFileSync(demoImageSrc, demoImageDest);
+  }
+};
+
 console.log(`Creating Marp presentation: ${projectName}`);
 console.log();
 
-try {
-  // Создаём папку проекта
-  fs.mkdirSync(projectPath, { recursive: true });
-
-  // Рекурсивно копируем template
-  const copyDir = (src, dest) => {
-    const entries = fs.readdirSync(src, { withFileTypes: true });
+// Основной async flow
+(async () => {
+  try {
+    // Запрашиваем создание примеров
+    const createExamples = await askCreateExamples();
 
-    for (const entry of entries) {
-      const srcPath = path.join(src, entry.name);
-      const destPath = path.join(dest, entry.name);
+    // Создаём папку проекта
+    fs.mkdirSync(projectPath, { recursive: true });
 
-      if (entry.isDirectory()) {
-        fs.mkdirSync(destPath, { recursive: true });
-        copyDir(srcPath, destPath);
-      } else {
-        fs.copyFileSync(srcPath, destPath);
-      }
-    }
-  };
+    // Рекурсивно копируем template
+    copyDir(templatePath, projectPath);
 
-  copyDir(templatePath, projectPath);
+    console.log('✓ Project created');
 
-  console.log('✓ Project created');
-  console.log();
+    // Копируем опциональные файлы
+    if (createExamples) {
+      copyOptionalFiles(projectPath);
+      console.log('✓ Example slides added');
+      console.log('✓ Demo image added to static/');
+    }
+    console.log();
+
+    // Запускаем npm install
+    console.log('Installing dependencies...');
+    const installResult = spawnSync('npm', ['install'], {
+      cwd: projectPath,
+      stdio: 'inherit',
+    });
+
+    if (installResult.status !== 0) {
+      console.error();
+      console.error('Failed to install dependencies.');
+      console.error('Please run "cd ' + projectName + ' && npm install" manually.');
+      process.exit(1);
+    }
 
-  // Запускаем npm install
-  console.log('Installing dependencies...');
-  const installResult = spawnSync('npm', ['install'], {
-    cwd: projectPath,
-    stdio: 'inherit',
-  });
+    console.log();
+    console.log('✓ Dependencies installed');
+    console.log();
+    console.log('Next steps:');
+    console.log(`  cd ${projectName}`);
+    console.log('  npm run dev        # Start live preview');
+    if (createExamples) {
+      console.log('  marp examples.md   # Preview example slides');
+    }
+    console.log('  npm run build:all  # Build all formats');
+    console.log();
 
-  if (installResult.status !== 0) {
-    console.error();
-    console.error('Failed to install dependencies.');
-    console.error('Please run "cd ' + projectName + ' && npm install" manually.');
+  } catch (err) {
+    console.error('Error creating project:', err.message);
     process.exit(1);
   }
-
-  console.log();
-  console.log('✓ Dependencies installed');
-  console.log();
-  console.log('Next steps:');
-  console.log(`  cd ${projectName}`);
-  console.log('  npm run dev     # Start live preview');
-  console.log('  npm run build:all  # Build all formats');
-  console.log();
-
-} catch (err) {
-  console.error('Error creating project:', err.message);
-  process.exit(1);
-}
+})();

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "create-marp-presentation",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Create a new Marp presentation project with one command",
   "bin": {
     "create-marp-presentation": "index.js"
   },
   "files": [
     "index.js",
-    "template/"
+    "template/",
+    "template-optional/"
   ],
   "scripts": {
     "test": "jest"

package/template/README.md

@@ -1,39 +1,39 @@
 # Marp Presentation
 
-Шаблон для создания презентаций с Marp.
+A template for creating presentations with Marp.
 
-## Начало работы
+## Getting Started
 
-### Live-предпросмотр
+### Live Preview
 
 ```bash
 npm run dev
 ```
 
-Откроется браузер с автообновлением при изменениях.
+Opens a browser with auto-reload on changes.
 
-### Создание слайдов
+### Creating Slides
 
-Редактируйте `presentation.md` — это главный файл презентации.
+Edit `presentation.md` — this is the main presentation file.
 
-## Сборка презентации
+## Building the Presentation
 
 ```bash
-npm run build:html    # HTML презентация (интерактивная)
-npm run build:pdf     # PDF файл
+npm run build:html    # HTML presentation (interactive)
+npm run build:pdf     # PDF file
 npm run build:pptx    # PowerPoint
-npm run build:all     # Все форматы сразу
+npm run build:all     # All formats at once
 ```
 
-Результат появится в папке `output/`.
+The output will appear in the `output/` folder.
 
-## Статические файлы
+## Static Files
 
-Поместите изображения и другие файлы в папку, указанную в `marp.config.js`.
+Place images and other files in the folder specified in `marp.config.js`.
 
-По умолчанию: `static/`
+Default: `static/`
 
-Вы можете добавить дополнительные папки в `marp.config.js`:
+You can add additional folders in `marp.config.js`:
 
 ```javascript
 module.exports = {
@@ -42,15 +42,15 @@ module.exports = {
 };
 ```
 
-## Очистка
+## Cleaning Up
 
 ```bash
 npm run clean
 ```
 
-Удаляет папку `output/`.
+Removes the `output/` folder.
 
-## Полезные ссылки
+## Useful Links
 
 - [Marp Documentation](https://marp.app/)
 - [Marp CLI](https://github.com/marp-team/marp-cli)

package/template/presentation.md

@@ -4,28 +4,28 @@ theme: default
 paginate: true
 ---
 
-# Моя презентация
+# My Presentation
 
-Добро пожаловать в вашу новую Marp презентацию!
+Welcome to your new Marp presentation!
 
 ---
 
-## О Marp
+## About Marp
 
-Marp (Markdown Presentation Ecosystem) — это инструмент для создания презентаций на Markdown.
+Marp (Markdown Presentation Ecosystem) is a tool for creating presentations in Markdown.
 
 ---
 
-## Возможности
+## Features
 
-- **Простой Markdown** - пишите слайды в привычном формате
-- **Темы** - используйте встроенные или создайте свою
-- **Экспорт** - HTML, PDF, PowerPoint
-- **Live preview** - мгновенный предпросмотр изменений
+- **Simple Markdown** - write slides in a familiar format
+- **Themes** - use built-in ones or create your own
+- **Export** - HTML, PDF, PowerPoint
+- **Live preview** - instant preview of changes
 
 ---
 
-## Код с подсветкой
+## Code with Syntax Highlighting
 
 ```javascript
 function hello() {
@@ -35,9 +35,9 @@ function hello() {
 
 ---
 
-## Изображения
+## Images
 
-Поместите изображения в папку `static/` и используйте их:
+Place images in the `static/` folder and use them:
 
 ```
 ![alt text](static/image.png)
@@ -45,6 +45,6 @@ function hello() {
 
 ---
 
-# Вопросы?
+# Questions?
 
-Документация: https://marp.app/
+Documentation: https://marp.app/

package/template-optional/examples.md

@@ -0,0 +1,249 @@
+---
+marp: true
+theme: default
+paginate: true
+math: katex
+---
+
+# Marp Examples
+
+Complete demonstration of Marp presentation capabilities
+
+---
+
+## Table of Contents
+
+<!-- This auto-generates a table of contents -->
+1. [Basic Formatting](#basic-formatting)
+2. [Lists](#lists)
+3. [Quotes and Footnotes](#quotes-and-footnotes)
+4. [Code](#code)
+5. [Tables](#tables)
+6. [LaTeX Formulas](#latex-formulas)
+7. [Images](#images)
+8. [Multi-column Layouts](#multi-column-layouts)
+9. [Backgrounds and Styling](#backgrounds-and-styling)
+10. [Fragments (Animations)](#fragments-animations)
+
+---
+
+## Basic Formatting
+
+### Headings work like regular Markdown
+
+This is **bold text** and this is *italic text*.
+
+You can also use ~~strikethrough~~ and `inline code`.
+
+---
+
+## Lists
+
+### Unordered Lists
+
+- First item
+- Second item
+  - Nested item
+  - Another nested item
+- Third item
+
+### Ordered Lists
+
+1. First step
+2. Second step
+3. Third step
+
+---
+
+## Quotes and Footnotes
+
+> This is a blockquote.
+> It can span multiple lines.
+>
+> — Author Name
+
+Here's a sentence with a footnote[^1].
+
+[^1]: This is the footnote content that appears at the bottom.
+
+---
+
+## Code
+
+### JavaScript
+
+```javascript
+function greet(name) {
+  console.log(`Hello, ${name}!`);
+}
+
+greet('Marp');
+```
+
+### Python
+
+```python
+def fibonacci(n):
+    if n <= 1:
+        return n
+    return fibonacci(n-1) + fibonacci(n-2)
+
+print(fibonacci(10))
+```
+
+---
+
+## Tables
+
+
+### Simple Table
+
+| Feature | Status | Notes |
+|---------|--------|-------|
+| Markdown | Yes | Full support |
+| Code blocks | Yes | Syntax highlighting |
+| Images | Yes | Local and remote |
+| Math | Yes | KaTeX support |
+
+---
+
+## Tables
+
+### Aligned Columns
+
+| Left | Center | Right |
+|:-----|:------:|------:|
+| Default | Centered | Numbers |
+| Text | Text | 1,234 |
+| More | Data | 5,678 |
+
+
+
+---
+
+## LaTeX Formulas
+
+### Inline and Block Math
+
+Inline formula: $E = mc^2$
+
+Block formula:
+
+$$
+\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
+$$
+
+---
+## LaTeX Formulas
+
+### More Examples
+
+Quadratic formula:
+
+$$
+x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
+$$
+
+Matrix:
+
+$$
+\begin{pmatrix}
+a & b \\
+c & d
+\end{pmatrix}
+$$
+
+---
+
+## Images
+
+### Basic Image
+
+![Demo image](static/demo-image.png)
+
+---
+
+## Images
+
+### Sized Image
+
+![width:300px](static/demo-image.png)
+
+---
+
+## Multi-column Layouts
+
+### Using HTML Tables
+
+<table>
+<tr>
+<td>
+
+**Left Column**
+
+- Point one
+- Point two
+- Point three
+
+</td>
+<td>
+
+**Right Column**
+
+- Another point
+- More content
+- Final item
+
+</td>
+</tr>
+</table>
+
+---
+
+## Backgrounds and Styling
+
+<!-- _backgroundColor: #1a1a2e -->
+<!-- _color: #eaeaea -->
+
+### Dark Slide
+
+This slide has a custom dark background and light text color.
+
+You can use HTML color codes or named colors.
+
+---
+
+<!-- _backgroundImage: url('static/demo-image.png') -->
+<!-- _backgroundOpacity: 0.3 -->
+
+### Image Background
+
+This slide has an image background with reduced opacity.
+
+---
+
+## Fragments (Animations)
+
+Use asterisk `*` for incremental reveal:
+
+* This appears first
+* This appears second
+* This appears third
+* This appears last
+
+Press space to reveal each item!
+
+---
+
+<!-- _paginate: false -->
+
+# Thank You!
+
+## Questions?
+
+- GitHub: https://github.com/marp-team/marp
+- Docs: https://marp.app/
+
+```
+Contact: your-email@example.com
+```