https://github.com/jrappen/sublime-distractionless

Automatic windowed distraction free mode while editing in Sublime Text.
https://github.com/jrappen/sublime-distractionless

distraction-free sublime-text sublime-text-package

Last synced: about 1 month ago
JSON representation

Automatic windowed distraction free mode while editing in Sublime Text.

• Host: GitHub
• URL: https://github.com/jrappen/sublime-distractionless
• Owner: jrappen
• License: isc
• Created: 2016-09-01T13:41:51.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-02-21T10:47:49.000Z (about 1 year ago)
• Last Synced: 2024-07-30T20:45:31.109Z (10 months ago)
• Topics: distraction-free, sublime-text, sublime-text-package
• Language: Python
• Homepage:
• Size: 2.94 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![License](https://img.shields.io/github/license/jrappen/sublime-distractionless.svg?style=flat-square)](https://github.com/jrappen/sublime-distractionless/blob/master/LICENSE)

[![Required ST Build](https://img.shields.io/badge/ST-4081+-orange.svg?style=flat-square&logo=sublime-text)](https://www.sublimetext.com)

[![Downloads Package Control](https://img.shields.io/packagecontrol/dt/distractionless.svg?style=flat-square)](https://packagecontrol.io/packages/distractionless)

[![Latest tag](https://img.shields.io/github/tag/jrappen/sublime-distractionless.svg?style=flat-square&logo=github)](https://github.com/jrappen/sublime-distractionless/tags)

[![Donate via PayPal](https://img.shields.io/badge/paypal.me-jrappen-009cde.svg?style=flat-square&logo=paypal)](https://www.paypal.me/jrappen)

# `distractionless` plug-in for [Sublime Text](https://www.sublimetext.com)

> Automatic windowed distraction free mode while editing in Sublime Text.

* [Requirements](#requirements)

* [Installation](#installation)

* [Usage](#usage)

* [Source Code](#source-code)

* [Donations](#donations)

![Screencast](./docs/img/screencast.gif)

### Code of conduct

### Contributing guide

## Requirements

`distractionless` targets and is tested against the **latest Build** of Sublime Text, currently requiring **`Build 4081`** or later.

* Download [Sublime Text](https://www.sublimetext.com)

* [Install Package Control](https://packagecontrol.io/installation) via the menu `Tools > Install Package Control`

    * Close and reopen Sublime Text after having installed Package Control.

## Installation

Using **Package Control** is required, as it keeps your packages (with their dependencies) up-to-date!

### Installation via Package Control

* Open the Command Palette (`Tools > Command Palette`).

* Choose `Package Control: Install Package`.

* Search for [`distractionless` on Package Control](https://packagecontrol.io/packages/distractionless) and select to install.

## Usage

`distractionless` makes Sublime Text automatically enter [Distraction Free mode](https://www.sublimetext.com/docs/distraction_free.html) in a windowed environment when you start editing a file.

`distractionless` will then make Sublime Text automatically switch back to normal mode as soon as:

* you save, open or clone a file.

* you open new, switch or close tabs.

* Sublime Text gains focus.

### Settings

Use the settings of Sublime Text to customize how views are displayed in each mode:

* `Preferences > Settings`

* `Preferences > Settings - Syntax Specific`

* `Preferences > Settings - Distraction Free`

You might want to set the following in `Preferences > Settings`:

```jsonc

// Packages/User/Preferences.sublime-settings

{

    "auto_hide_menu": true,

    "auto_hide_status_bar": true,

    "auto_hide_tabs": true,

    // number of changes after which UI is toggled automatically

    "distractionless.toggle_after": 1,

    // toggle minimap when switching modes

    "distractionless.toggle_minimap": true,

    // toggle sidebar when switching modes

    "distractionless.toggle_sidebar": true

}

```

## Source Code

### License

### Issues

Please use the command palette or the main menu to report an issue.

## Donations