~stormdragon2976/bashtml

169fd08ab5691260c12ac79ca110fc756a36067a — Storm Dragon 1 year, 7 months ago dcc576c
updated README
1 files changed, 24 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +24 -1
@@ 14,7 14,7 @@ Create the directory where you want your site:
    cd mysite


Run bashtml with no arguments to generate the configuration file, called .bashtmlrc. After the file has been created, edit it and change the information to personalize your site.A
Run bashtml with no arguments to generate the configuration file, called .bashtmlrc. After the file has been created, edit it and change the information to personalize your site.


## Options


@@ 26,3 26,26 @@ The following options are available.
- -h, --help: A brief help message.
- -n, -p, --post: Create a new post.
- -s, --sync: Sync your local copy of the site to the server, requires the rsync section of the configuration file be set.


## Plugins


Plugins extend the functionality of bashtml. A few plugins are included by default, but are not active by default. In your site directory, create a  directory called bashtml-plugins. Place the plugin you want to use in the bashtml-plugins directory. The last part of the file name determines the type of plugin. For example, the name myplugin.prefooter means that the plugin is type prefooter, and will appear just before the footer on the page.


Plugins will have access to the settings variable in the .bashtmlrc. This means that your plugin will be able to use things like author, etc. Plugins are also sent the current pagename where applicable. The pre and post sync plugin types do not receive the page name.


### Plugin Types


- meta: Runs in the meta section of the head tag.
- presync: Runs before the rsync command is called.
- postsync: Runs after the rsync command is called.
- preheader: Runs just before the header section of the page.
- postheader: Runs just after the fheader section of the page.
- prefooter: Runs just before the footer section of the page.
- footer: Runs in the footer section of the page.
- postfooter: Runs just after the footer section of the page.
- post: Called when an article is created successfully.