Skip to content

0xShishigami/fastlane-ux

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fastlane UX Slides

A presentation about Fastlane UX - a bridge between code and design, built with Marp for creating beautiful slides from Markdown.

🎯 About Fastlane UX

Fastlane UX is a proposal to strengthen development workflows by introducing a simple clarity step that:

  • 🚫 Reduces rework by catching UX issues early
  • ⚠️ Ensures product quality through better alignment
  • 🧩 Creates predictable flow for development teams

🚀 Features

  • Markdown-based slides - Write presentations in simple Markdown
  • Multiple Rose Pine themes - Dawn, Moon, and default variants
  • Mermaid diagrams - Support for creating user flow diagrams
  • Local file support - Include local images and assets
  • Multiple output formats - Generate HTML, PDF, and PowerPoint presentations
  • Live preview - Real-time development with auto-reload

📁 Project Structure

slides/
├── slides/           # Source Markdown files
│   ├── slide.md     # Main Fastlane UX presentation
│   ├── slide.pdf    # Generated PDF presentation
│   ├── slide.pptx   # Generated PowerPoint presentation
│   └── img/         # Presentation images
├── themes/          # Custom CSS themes
│   ├── rose-pine.css
│   ├── rose-pine-dawn.css
│   └── rose-pine-moon.css
├── docs/            # Documentation and resources
├── index.html       # Generated HTML presentation (GitHub Pages ready)
├── marp.config.js   # Marp configuration
└── package.json     # Project dependencies

🛠️ Setup

Install dependencies:

pnpm install

📖 Usage

Using npm scripts (recommended)

# Start live presentation server
npm run dev

# Generate HTML presentation
npm run build:html

# Generate PDF presentation
npm run build:pdf

# Generate PowerPoint presentation
npm run build:pptx

# Generate all formats at once
npm run build:all

# Live preview with auto-reload
npm run preview

Direct Marp commands

# Live presentation server (recommended)
marp -s -c marp.config.js

# Generate HTML presentation
marp --html --output index.html slides/slide.md

# Generate PDF presentation
marp --pdf --output slides/slide.pdf slides/slide.md

# Generate PowerPoint presentation
marp --pptx --output slides/slide.pptx slides/slide.md

# Live preview with auto-reload
marp slides/slide.md --server --watch

🎨 Themes

This project includes three Rose Pine themes:

  • rose-pine.css - Default Rose Pine theme
  • rose-pine-dawn.css - Light variant (currently used)
  • rose-pine-moon.css - Dark variant

To use a specific theme in your slides, add this to your Markdown:

---
marp: true
theme: rose-pine-dawn
---

📊 Diagrams

This project supports Mermaid diagrams for creating user flow diagrams. You can create various types of diagrams using Mermaid syntax in your Markdown:

```mermaid
flowchart TD
    A[/UI Trigger/] --> B[[Processing]]
    B --> C{Decision?}
    C -->|Yes| D[Success]
    C -->|No| E(((Error)))

### User Flow Standard

The presentation includes a standardized approach to user flow diagrams:
- `[/…/]` - UI Trigger (user actions)
- `[\…\]` - UI Prompt (user input requests)
- `[…]` - System Output (UI feedback)
- `[[…]]` - Processing (system logic)
- `{…}` - Decision (branching logic)
- `(((…)))` - Error (error states)

## 🔧 Configuration

The project is configured via `marp.config.js`:
- Input directory: `./slides`
- Local files allowed: `true`
- Kroki integration enabled for Mermaid diagrams
- Custom Rose Pine theme set included

**Note:** The configuration has been updated to process only the main presentation file (`slides/slide.md`). HTML files are generated as `index.html` in the root directory for GitHub Pages compatibility, while PDF and PPTX files are generated in the `/slides` directory.

## 📝 Writing Slides

Write your slides in Markdown format. Each slide is separated by `---`:

```markdown
---
marp: true
theme: rose-pine-dawn
paginate: true
---

# Slide 1
Content goes here

---

# Slide 2
More content here

🎨 Wireframing Tools

The presentation covers wireframing tools for non-designers:

  • Excalidraw - Sketch-like wireframing tool
  • FigJam - Collaborative whiteboard
  • Mermaid - Text-based diagramming

🚀 Development

  • Edit slides/slide.md to modify your presentation
  • Use marp --server --watch for live preview during development
  • Generated files are automatically ignored by git (see .gitignore)

📚 Additional Resources

The presentation references several resources:

📄 License

ISC License

Releases

No releases published

Packages

 
 
 

Contributors