Skip to content

Latest commit

 

History

History
executable file
·
99 lines (61 loc) · 4.37 KB

README.md

File metadata and controls

executable file
·
99 lines (61 loc) · 4.37 KB
Raw

Genus

Description

A sketch plugin for exporting prototype website (static html css) from your sketch designs

How to install Genus

  1. Make sure you have Sketch installed in your Mac OS machine.
  2. Click on Genus Github zip download to get the compressed release.
  3. Unzip the downloaded file.
  4. Double click on Genus.sketchplugin to install the plugin.

User Guide

How to export HTML using Genus plugin

  1. Open your design made in Sketch (Alternatively, we have provided a test Sketch file in the zip file under testing>sketch>genus-test-cases.sketch).

    Open Sketch design

  2. Select the artboard(s) you want to export as HTML.

    Select artboard

  3. Go to the menu bar, Plugins>Genus>Export.

    Go to Genus export

  4. After processing, the HTML and associated assets are exported to the same location as the Sketch file. The path is also mentioned in the dialog box.

    Exported HTML at Sketch location

  5. Once exported, you can go the exported location and you will find folder(s) named after the name of your artboards(s) selected for export.

    Go to export location

  6. Open a folder and open index.html to see the result in your browser.

    Open html in browser

Tips for creating Sketch designs which can be helpful to create logical HTML output

  1. Naming each layer logically can greatly help in inspecting the generated HTML and trace back problems.
  2. Grouping logical entities can help you create nested divs.
  3. If the intent is to export groups as png, make a group exportable.

Troubleshooting/Known issues

  1. If there are any missing fonts notification which comes up on the top right of the Sketch application, please install them.
  2. In case fonts are not rendered properly in the browser, you might want to import the fonts in CSS. This can be done by:
    1. Adding Google fonts in your css file e.g. import following statement @import url('https://fonts.googleapis.com/css?family=Roboto:500,900|PT+Serif:400|Open+Sans:400'); (this is for installing fonts used in genus-test-cases.sketch sample file).
    2. Copying font files to a font folder in your Mac and then can also help fix issue.
  3. In some rare cases font weight rendered by html and sketch could be different. In those cases you might want to check correct font weight from sketch file and edit those values into generated css.

Development Guide

Installation

Important: Node.js > V6.x is a minimum requirement. You also need the command line tools installed.

This plugin was created using skpm. For a detailed explanation on how things work, checkout the skpm Readme.

Usage

Install the dependencies

npm install

Once the installation is done, you can run some commands inside the project folder:

npm run build

The folder *.sketchplugin is the plugin bundle generated by the skpm build process. DO NOT EDIT any of the files within this folder, any changes will be overwritten with the next build.

To watch for changes:

npm run watch

Additionally, if you wish to run the plugin every time it is built:

npm run start

Debugging

To view the output of your console.log, you have a few different options:

  • Use the sketch-dev-tools
  • Run skpm log in your Terminal, with the optional -f argument (skpm log -f) which causes skpm log to not stop when the end of logs is reached, but rather to wait for additional data to be appended to the input

Attributions

  1. HTML and CSS generation code for exporting images inspired from SketchHTMLExport plugin by mludowise
  2. Icon for plugin Image by Nikin from Pixabay