GithubHelp home page GithubHelp logo

doc22940 / puzzle-publisher Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ingrammicro/puzzle-publisher

1.0 1.0 0.0 28.42 MB

A Sketch plugin that exports Sketch artboards into clickable HTML file and publishes it on an external site.

License: GNU General Public License v3.0

JavaScript 86.65% CSS 5.31% Shell 1.29% PHP 6.75%

puzzle-publisher's Introduction

Puzzle Publisher

A Sketch plugin that exports Sketch artboards into clickable HTML file.

Join Spectrum Chat for live talk

Features:

  • Single HTML file with links highlighting
  • Show artboard as an overlay over a previous artboard / Pict 1, Pict 2, Pict 3 / Example
  • Show artboard as a modal over a previous artboard / Picture, Example
  • Support for layers with fixed position (left,top and float panels) / Example
  • Support for Sketch-native links (including Back links, cross-page links, links inside Symbols and overrided hotspot links)
  • Support for external links / Hint
  • Skips pages and artboards with * prefix
  • Ability to insert Google counter
  • Ability to hide navigation controls and hotspot highlighting
  • Automatic compression of images

Viewer features:

  • Gallery / Picture
  • Async pre-loading of all page images
  • Auto-scale of large pages to fit into small browser window
  • Ability to get <iframe> code to embed you prototypes into external web pages (with special UI) or get lightweight code with just <img...></a/>
  • Page layout viewer (if it was enabled for a page)
  • [NEW] Element Inspector to see symbols, styles and design tokens(requires integration with Design System plugin) (Picture)

Publisher features:

  • Increasing of version counter and injecting it into HTML
  • Publishing to external site by SFTP
  • Announce new version changes in Telegram channel

Run from command line:

  • Export HTML from command line / Hint

Change Log

Please send your feedback and requests to [email protected]

Screenshots

Commands:

Settings:

Viewer - Show symbols (and design tokens):

Installation

To install, download the zip file and double-click on PuzzlePublisher.sketchplugin. The commands will show up under Plugins > Puzzle Publisher.

Usage

You can use Sketch-native links or add links to external sites. When you're finished adding these you can generate a HTML website of the all document pages by selecting Export to HTML. The generated files can then be uploaded to a server so you can show it to your clients.

Retina Images

By default it will show 2x images for high pixel density screens. To turn this off uncheck Export retina images in Settings and re-export the page.

Special magic string in layer names

  • @MainBackground@: a shape layer background color will be used as a default color for browser pages
  • @SiteIcon@: an image layer will be rendered as site icon for mockups
  • @Redirect@: a link from a marked hostpot will be used to show a page under an overlay (example)

puzzle-publisher's People

Contributors

maxbazarov avatar zubr133 avatar atalun avatar form-follows-function avatar akalenyuk avatar

Stargazers

Acampbell avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.