# docs.sublimetext.io

**Repository Path**: onewayout/docs.sublimetext.io

## Basic Information

- **Project Name**: docs.sublimetext.io
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-07
- **Last Updated**: 2023-11-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sublime Text Community Documentation

We started this project
to fill the gaps
in the Sublime Text [official documentation][off-docs].

***[Read this guide online for free.][docs]***

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

Huge thanks to [all our backers](./BACKERS.md)
from our [fundraiser in 2014 on BountySource][fundraiser]!


## 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][issues],
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](./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](https://pnpm.io/installation).
2. Run:
    - `pnpm i`
    - `pnpm run dev`


[off-docs]: https://sublimetext.com/docs/3
[docs]: https://docs.sublimetext.io/
[trello]: https://trello.com/b/ArLlY4X7/sublime-text-unofficial-documentation
[fundraiser]: https://www.bountysource.com/teams/st-undocs/fundraiser
[Git LFS]: https://git-lfs.github.com/
[Vitepress]: https://vitepress.dev/

[issues]: https://github.com/sublimetext-io/docs.sublimetext.io/issues