A collection of snippets and tools for Jekyll in Atom
Jekyll-Atom has a few 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/
Sites Dir
The path to the compiled site, defaults to _site/
Server Port
The port used by static-server, defaults to 3000
Build Command
An array containing the command to build a site, defaults to jekyll, build
Jekyll-Atom can host a server to preview your site!
The server runs in the background and can be started/stopped from anywhere using the Toggle Server command Alt-Shift-T
.
Whilst running any time you save in Atom your site will be built and available on the port you set in config.
When triggered this function looks through your file for layout: foo
and then opens LAYOUTS_DIR/foo.LAYOUT_FORMAT
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
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.
Opens _config.yml
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.
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
There are a load of snippets provided by this plugin, please check the settings pane in atom for a full list.
Feel free to fork this repo and submit changes!
When you fork Jekyll-Atom please:
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request