Mercurial > vim-piecrust

annotate doc/piecrust.txt @ 3:af8514b79c04 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix for PieCrust 1.0-rc1. Added very simple `Pcprepare` command.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 14 Mar 2013 22:15:58 -0700
parents d09875b9f100
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1 *piecrust.txt* PieCrust wrapper for VIM
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4 VIM-PIECRUST REFERENCE MANUAL
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5 by Ludovic Chabant
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8 *piecrust*
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10 1. Introduction |piecrust-intro|
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11 2. Commands |piecrust-commands|
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14 =============================================================================
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
15 1. Introduction *piecrust-intro*
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
16
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17 PieCrust is a static website generator and lightweight CMS. You can learn more
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18 about it on the official website:
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
19
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
20 http://bolt80.com/piecrust
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
22 When a file from a PieCrust website is open in a buffer, that buffer gets new
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
23 commands defined.
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
24
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
25 Grab the latest version or report a bug on BitBucket:
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
26
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27 http://bitbucket.org/ludovicchabant/vim-piecrust
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
28
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
29
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
30 =============================================================================
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
31 2. Introduction *piecrust-commands*
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
32
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
33 All commands defined by |piecrust| are local to each buffer.
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
34
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35 *Pcedit*
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
36 :Pcedit {args} Opens a page, post or template file from the current
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37 website given a website relative path.
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
38 The given {args} can be a part of the wanted file's
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
39 name, a glob pattern, or a regex pattern. In that case,
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
40 the auto-completion will provide the appropriate
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
41 matching files.
d09875b9f100 Initial commit.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
42