SwiftMark Preview

A lightweight, fast, and simple markdown previewer for Visual Studio Code with PDF export functionality.

Features

• Clean White Theme: Simple, distraction-free markdown preview in a clean white theme
• Syntax Highlighting: Beautiful code syntax highlighting using highlight.js
• PDF Export: Export your markdown files to PDF with customizable margins and page sizes
• Fast & Lightweight: Minimal dependencies for quick loading and rendering
• VS Code Integration: Seamlessly integrated with VS Code's markdown editing experience

Preview

Installation

From VS Code Marketplace

1. Open VS Code
2. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the Command Palette
3. Type Extensions: Install Extensions
4. Search for SwiftMark Preview
5. Click Install

From Command Line

code --install-extension durgeshvaigandla.swiftmark-preview

Manual Installation

1. Download the .vsix file from the Releases page
2. In VS Code, press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
3. Type Extensions: Install from VSIX...
4. Select the downloaded .vsix file

Usage

Opening Preview

1. Open a markdown file (.md) in VS Code
2. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the Command Palette
3. Type SwiftMark: Open Preview
4. Press Enter

Keyboard Shortcuts

• Ctrl+Shift+V (or Cmd+Shift+V on Mac): Open SwiftMark Preview
• Ctrl+Shift+S (or Cmd+Shift+S on Mac): Export to PDF

Exporting to PDF

1. With a markdown file open, use the Command Palette or keyboard shortcut
2. Choose SwiftMark: Export to PDF
3. Select your desired PDF settings
4. Choose save location

Configuration

SwiftMark Preview offers minimal configuration options to keep things simple:

Syntax Highlighting Theme

Choose from popular syntax highlighting themes:

{
  "swiftmark.syntaxHighlightingTheme": "github"
}

Available themes:

• github (default) - GitHub's syntax highlighting
• github-dark - GitHub Dark theme
• atom-one-light - Atom One Light
• atom-one-dark - Atom One Dark
• vs - Visual Studio theme
• vs2015 - Visual Studio 2015 theme

PDF Export Settings

Configure PDF export options:

{
  "swiftmark.pdfFormat": "A4",
  "swiftmark.pdfMargin": "1cm"
}

Available options:

• pdfFormat: Page format ("A4", "A3", "A5", "Legal", "Letter", "Tabloid")
• pdfMargin: Margin size (e.g., "1cm", "0.5in")

Requirements

• Visual Studio Code 1.74.0 or higher
• No additional dependencies required

Extension Settings

This extension contributes the following settings:

• swiftmark.syntaxHighlightingTheme: Choose syntax highlighting theme
• swiftmark.pdfMargin: Set PDF export margins
• swiftmark.pdfFormat: Set PDF page format

Known Issues

• Some advanced markdown features may not be supported in this lightweight version
• PDF export quality depends on system fonts and rendering

Release Notes

1.0.0

• Initial release of simplified SwiftMark Preview
• Clean white theme markdown preview
• Basic syntax highlighting
• PDF export functionality
• Minimal configuration options

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

1. Clone the repository:

git clone https://github.com/durgeshvaigandla/swiftmark-preview.git
cd swiftmark-preview

2. Install dependencies:

npm install

3. Open in VS Code:

code .

4. Press F5 to start debugging the extension

Building

npm run compile

Packaging

npm run package

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions:

1. Check the Issues page
2. Create a new issue with detailed information
3. Include your VS Code version and extension version

Changelog

See CHANGELOG.md for a complete list of changes.

SwiftMark Preview - Simple, fast, and reliable markdown previewing for VS Code.