https://github.com/sublimetext-io/docs.sublimetext.io

Sublime Text Community Documentation
https://github.com/sublimetext-io/docs.sublimetext.io

community-driven documentation guide hacktoberfest sublime-text

Last synced: 5 days ago
JSON representation

Sublime Text Community Documentation

• Host: GitHub
• URL: https://github.com/sublimetext-io/docs.sublimetext.io
• Owner: sublimetext-io
• License: other
• Created: 2020-03-18T23:54:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T17:54:23.000Z (2 months ago)
• Last Synced: 2024-08-28T19:39:56.222Z (2 months ago)
• Topics: community-driven, documentation, guide, hacktoberfest, sublime-text
• Language: Markdown
• Homepage: https://docs.sublimetext.io/
• Size: 17.6 MB
• Stars: 186
• Watchers: 8
• Forks: 53
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt
  • Authors: AUTHORS.txt

Awesome Lists containing this project

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