Javascript API for working with Sketch 中文翻译
Switch branches/tags
develop feature/139 feature/8014-default-border-position-style feature/9135 feature/15320-improve-arrows-on-paths feature/15737-add-support-for-symbols-in feature/15747 feature/15748 feature/15906--coscript-shouldkeeparound feature/16204-have-move-to-top-arrange-option feature/16238-add-support-for-libraries feature/16350-investigate-require-syntax feature/16539-temporary-solution-for-deploying feature/16869-bring-artboards-and-slices feature/16878 feature/16983-properly-add-console-global feature/17039 feature/17151 feature/17202 feature/17228 feature/17291-style feature/17367 feature/17424 feature/17428-small-ui-improvements-for feature/17540-more-general-routine-for-converting feature/17577-prettify-the-plugin-icon-for feature/17642-remove-sketchapi-as-a-submodule feature/17854 feature/17891 feature/17934-backend-changes-to-data feature/18200 feature/18387-xcode931 feature/18593-improve-performance-of-override feature/18736 feature/18824 feature/18848-fix-axis-docs-build-warning feature/18875-xcode-9-4 feature/18890 feature/19012 feature/19049-upgrade-sketch-xcode-10 feature/19076 fix-for-document-open gh-pages release/40 release/40.1 release/40.2 release/40.3 release/41 release/41.1 release/41.2 release/42 release/43 release/43.1 release/43.2 release/44 release/44.1 release/44.2 release/45 release/45.1 release/45.2 release/46 release/46.1 release/46.2 release/47 release/47.1 release/48.1 release/48.2 release/49 release/49.1 release/49.2 release/49.3 release/50 release/50.2 release/51 release/999
Nothing to show
Clone or download
Pull request Compare This branch is 35 commits ahead, 23 commits behind BohemianCoding:gh-pages.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

此存储库为 Sketch 的开发者文档中文站点提供支持,该站点位于

本页面为此存储库的说明文件, 非原仓库 的翻译.


We've made this repository public so you can contribute to it. If you find a typo, or an error, or want to improve the content, feel free to send us a pull request. Also, if there's anything you'd like to see covered or documented, file an issue and we'll do it for you.

We use Jekyll as our content backend, so make sure to read their docs if you need help understanding how the system works.


If you want to get the site working locally, you'll need to have node and bundler installed. On OS X you'll also need to have Xcode's command line tools installed (xcode-select --install).

Once you have them, run this:


in the project root to start the server. The run script will take care of installing all the needed dependencies if they’re not installed, so it may take a while if it’s the first time you’re running it.

Note: you may find issues with nokogiri when running run. If that's the case, try the following:

  bundle config build.nokogiri --use-system-libraries --with-xml2-include=/usr/include/libxml2/

If that doesn't work, check the troubleshooting tips on Nokogiri's page

Generated Sections

As well as the normal Jekyll processing, there are some areas of the site where the source files are themselves generated by other tools. In particular:

  • The API documentation is stored in the SketchAPI repo to keep it close to the code.

Both of these scripts have some dependencies, and neither are really set up to be run by other people (nor should it be necessary to do so). It's worth knowing that they are there however! Don't waste time hand-editing this generated content, as it will just get replaced next time the scripts are run. Instead, file pull-requests to change the things that the scripts generate the content from - eg the SketchAPI repo or the repos for the example plugins (all of which are open-source).