Skip to content

sublimetext-io/docs.sublimetext.io

Repository files navigation

Sublime Text Community Documentation

We started this project to fill the gaps in the Sublime Text official documentation.

Read this guide online for free.

You can follow our progress here and on our public Trello board.

Huge thanks to all our backers from our fundraiser in 2014 on BountySource!

Contributing

This guide is hosted on Github Pages and built with Vitepress. We use Git LFS (large file storage) for larger artifacts embedded in the guide, such as videos.

We accept error reports and requests for new content via our issue tracker, and encourage you to send pull requests (but we cannot guarantee they will be merged).

Please follow our style guidelines as described in CONTRIBUTING.md.

This repository includes a .sublime-project with predefined settings and helpful build systems.

Building (HTML Preview)

In order to build and preview the docs, you'll need pnpm.

  1. Install Pnpm.
  2. Run:
    • pnpm i
    • pnpm run dev