mirror of https://git.envs.net/envs/burrow.git
rss support added
This commit is contained in:
parent
445f6a30a9
commit
488e27ea03
12
README.md
12
README.md
|
@ -35,6 +35,7 @@ See the [Getting Started](https://github.com/jamestomasino/burrow/wiki/Getting-S
|
|||
burrow phlog # create new phlog post
|
||||
burrow recipe # add or update a recipe to box
|
||||
burrow topic # add or update a topic file
|
||||
burrow rss # generate a RSS feed of phlog entries
|
||||
burrow create-config # generate a default config file
|
||||
burrow edit-config # open your config file for editing
|
||||
burrow update-git # pull latest git repo for gopher dir, if exists
|
||||
|
@ -61,6 +62,10 @@ by including a `.template` file in your recipe box directory.
|
|||
`$EDITOR`. By default it will provide you a template, but you can override this
|
||||
by including a `.template` file in your topics directory.
|
||||
|
||||
- `rss` will automatically generate an RSS feed of your most recent phlog
|
||||
entries and output it to the root of your gopher directory. This can be
|
||||
automatically generated by using the config option `config_phlog_autorss`.
|
||||
|
||||
- `update-git` will silently attempt to update a git repository at the location
|
||||
of your gopher hole. It is appropriate for use by a cron job.
|
||||
|
||||
|
@ -107,6 +112,13 @@ config_git_push=false # automatically push changes if git repo
|
|||
|
||||
config_autoindent=true # automatically reformat gophermaps with leading "i"
|
||||
# types and parse links at the end of file
|
||||
|
||||
config_file_rss="rss.xml" # filename of RSS feed
|
||||
config_gopher_name="My Gopher Hole" # used in RSS feed output
|
||||
config_gopher_desc="Description" # used in RSS feed output
|
||||
config_rss_num_entries="10" # number of entries to inclued in RSS feed
|
||||
config_phlog_autorss=true # automatically generate RSS feed
|
||||
|
||||
```
|
||||
|
||||
_Note: This file is a valid Bash script and will be sourced upon load._
|
||||
|
|
4
burrow
4
burrow
|
@ -1,6 +1,6 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
version="v1.3.3"
|
||||
version="v1.4.0"
|
||||
|
||||
shopt -s extglob
|
||||
configfiles="$HOME/.config/burrow/config $HOME/.config/burrow $HOME/.burrow"
|
||||
|
@ -24,7 +24,7 @@ config_git_push=false
|
|||
config_autoindent=true
|
||||
config_file_rss="rss.xml"
|
||||
config_gopher_name="My Gopher Hole"
|
||||
config_gopher_desc="Gopher Hole Description"
|
||||
config_gopher_desc="Description"
|
||||
config_rss_num_entries="10"
|
||||
config_phlog_autorss=false
|
||||
|
||||
|
|
42
burrow.1
42
burrow.1
|
@ -1,4 +1,4 @@
|
|||
.TH BURROW 1 "17 Mar 2018" "version 1.3.3"
|
||||
.TH BURROW 1 "17 Mar 2018" "version 1.4.0"
|
||||
.SH NAME
|
||||
burrow \- a helper for building and managing a gopher hole
|
||||
.SH SYNOPSIS
|
||||
|
@ -9,25 +9,47 @@ modification, and maintenance of a gopher hole.
|
|||
.SH COMMANDS
|
||||
.TP
|
||||
.B phlog
|
||||
Create a new phlog entry.
|
||||
Prompt for the title of a new post, then open it in your default
|
||||
$EDITOR. By default it will provide you a template, but you can override this
|
||||
by including a
|
||||
.I .template
|
||||
file in your phlog directory.
|
||||
.TP
|
||||
.B recipe
|
||||
Add or update a recipe to the recipe box.
|
||||
Prompt for the name of your recipe, then open it in your default
|
||||
$EDITOR. By default it will provide you a template, but you can override this
|
||||
by including a
|
||||
.I .template
|
||||
file in your recipe box directory.
|
||||
.TP
|
||||
.B topic
|
||||
Add or update a topic in your topics directory.
|
||||
Prompt for the name of the topic, then open it in your default
|
||||
$EDITOR. By default it will provide you a template, but you can override this
|
||||
by including a
|
||||
.I .template
|
||||
file in your topics directory.
|
||||
.TP
|
||||
.B rss
|
||||
Automatically generate an RSS feed of your most recent phlog
|
||||
entries and output it to the root of your gopher directory. This can be
|
||||
automatically generated by using the config option config_phlog_autorss.
|
||||
.TP
|
||||
.B create-config
|
||||
Generates a default configuration file at
|
||||
.I ~/.config/burrow/config
|
||||
if no other configuration file exists. It is populated with the default
|
||||
settings.
|
||||
Auto-generate a configuration file at
|
||||
.I $HOME/.config/burrow/config.
|
||||
It will be populated by the default parameters
|
||||
listed below and provide an easy way to customize your configuration. At a
|
||||
minimum you should update your
|
||||
.I config_dir_gopher
|
||||
to point to the folder on your local computer where your gopher hole resides.
|
||||
.TP
|
||||
.B edit-config
|
||||
Opens your burrow configuration file for editing if it exists.
|
||||
.TP
|
||||
.B update-git
|
||||
If the gopher directory resides within a git repository, this action will do a
|
||||
silent
|
||||
Silently attempt to update a git repository at the location
|
||||
of your gopher hole. It is appropriate for use by a cron job.
|
||||
.TP
|
||||
.B git-pull
|
||||
which is useful for crons.
|
||||
.TP
|
||||
|
|
Loading…
Reference in New Issue