<commit_before># Jekyll-Atom

A collection of snippets and tools for [Jekyll] in [Atom]

[![Jekyll Logo](https://raw.githubusercontent.com/Arcath/jekyll-atom/master/images/jekyll.png)](http://jekyllrb.com)

# Configuring

Jekyll-Atom has a couple of settings that can be set through the [Atom] settings.

`Layouts Dir` The path to your layouts, defaults to `_layouts/`

`Layouts Type` The file type of your layouts, defaults to `.html`

`Posts Dir` The path to your posts, defaults to `_posts/`

`Posts Type` The file type of your posts, defaults to `.markdown`

`Includes Dir` The path to your includes, defaults to `_includes/`

`Data Dir` The path to your data, defaults to `_data/`

`Server Options` The options passed to the Jekyll command to run your server, defaults to `serve, -w`

`Jekyll Binary` The command needed to run Jekyll, defaults to `jekyll` use `which jekyll` to find out where your command is stored (might be needed when using rbenv/rvm etc...)

# Usage

## Jekyll Manager

Jekyll Manager is a management console for Jekyll that runs in Atom. With Jekyll Manager you can now do all your Jekyll Development without leaving your editor!

![Jekyll Manager](https://raw.githubusercontent.com/Arcath/jekyll-atom/master/Jekyll-Manager.gif)

## Functions

### Open the layout for the current file

When triggered this function looks through your file for `layout: foo` and then opens `LAYOUTS_DIR/foo.LAYOUT_FORMAT`

### Open the include for the cursor position

When triggered this function opens up the include for the current tag. For example if you had `{% include snippet.html %}` Atom would open `INCLUDES_DIR/snippet.html`

### Create a new Post

When triggered this function brings up a popup at the top of the screen for you to type in the title of your new post e.g. `Something Really Cool!` (on the date 2/4/2014). When you submit the form a new file of `POSTSDIR/2014-04-02-something-really-cool.POST_FORMAT` will be created with a very basic front matter and opened on the screen.

### Open Config

Opens `_config.yml`

### Open Data File

When Triggered this function looks at the text around your cursor to find the data file to open. For Example triggering Open Data File whilst your cursor is within the `site.data.team` in this `{{ blah site.data.team }}` would result in `DATADIR/team.yml` being opened.

## Keyboard Shortcuts

`Cmd-Alt-L` Open the layout for the current file

`Cmd-Alt-J` Create a new post

`Cmd-Shift-I` Open include

## Snippets

There are a load of snippets provided by this plugin, please check the settings pane in atom for a full list.
<commit_msg>update the readme<commit_after># Jekyll-Atom

A collection of snippets and tools for [Jekyll] in [Atom]

[![Jekyll Logo](https://raw.githubusercontent.com/Arcath/jekyll-atom/master/images/jekyll.png)](http://jekyllrb.com)

# Configuring

Jekyll-Atom has a couple of settings that can be set through the [Atom] settings.

`Layouts Dir` The path to your layouts, defaults to `_layouts/`

`Layouts Type` The file type of your layouts, defaults to `.html`

`Posts Dir` The path to your posts, defaults to `_posts/`

`Posts Type` The file type of your posts, defaults to `.markdown`

`Includes Dir` The path to your includes, defaults to `_includes/`

`Data Dir` The path to your data, defaults to `_data/`

`Server Options` The options passed to the Jekyll command to run your server, defaults to `serve, -w`

`Jekyll Binary` The command needed to run Jekyll, defaults to `jekyll` use `which jekyll` to find out where your command is stored (might be needed when using rbenv/rvm etc...)

# Usage

## Server Management

Jeykll-Atom can run your Jekyll Server right in Atom!

Both the toolbar (`Cmd-Alt-T`) and the management window (_Jekyll: Mange_ in the Command Palette) have a console for the stdout output and buttons to control the server.

The server runs in the background and can be started/stopped from anywhere using the Toggle Server command `Alt-Shift-T`.

## Functions

### Open the layout for the current file

When triggered this function looks through your file for `layout: foo` and then opens `LAYOUTS_DIR/foo.LAYOUT_FORMAT`

### Open the include for the cursor position

When triggered this function opens up the include for the current tag. For example if you had `{% include snippet.html %}` Atom would open `INCLUDES_DIR/snippet.html`

### Create a new Post

When triggered this function brings up a popup at the top of the screen for you to type in the title of your new post e.g. `Something Really Cool!` (on the date 2/4/2014). When you submit the form a new file of `POSTSDIR/2014-04-02-something-really-cool.POST_FORMAT` will be created with a very basic front matter and opened on the screen.

### Open Config

Opens `_config.yml`

### Open Data File

When Triggered this function looks at the text around your cursor to find the data file to open. For Example triggering Open Data File whilst your cursor is within the `site.data.team` in this `{{ blah site.data.team }}` would result in `DATADIR/team.yml` being opened.

## Keyboard Shortcuts

`Cmd-Alt-L` Open the layout for the current file

`Cmd-Alt-D` Open the Datafile

`Cmd-Shift-I` Open include

`Cmd-Alt-J` Create a new post

`Cmd-Alt-T` Open the toolbar

`Alt-Shift-T` Turn the server on/off

## Snippets

There are a load of snippets provided by this plugin, please check the settings pane in atom for a full list.

{'fraction_non_alphanumeric': 0.08065112837587865, 'fraction_numerical': 0.005179430262671106, 'mean_word_length': 4.219111969111969, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '845896', 'n_tokens_mistral': 1664, 'n_tokens_neox': 1589, 'n_words': 782}