MARKDOWN2SOCIAL(1)

NAME
markdown2social - Converts simple Markdown documents to Google+ posts

SYNOPSIS
markdown2social [--config_file file] [--output_file file] [input_file1 .. input_fileN]
markdown2social --help
markdown2social --version

DESCRIPTION
In the first synopsis form, markdown2social converts Markdown documents to Google+ posts. In the second synopsis form, markdown2social displays interactive help. In the third synopsis form, markdown2social displays the package name and its version number.

Input files can be provided as the input_file1 .. input_fileN positional arguments. If none are given, the Markdown content is read from the standard input. If more than one input file is given, they are all concatenated.

The generated Google+ post is written to the standard output by default, but this can be overriden with the --output_file flag.

The following options are available:

--config_file file, -c file
    Specifies the path to the configuration file. If not provided, defaults to ~/.config/markdown2social.conf.

--output_file file, -o file
    Controls the path to the file that will receive the output of the conversion. If not provided, defaults to the standard output.

  Formatting suggestions
Because the formatting options supported by Google+ are extremely simple, this tool is very limited on what it can do with Markdown formatting. In particular, you should follow these guidelines in your Markdown documents for best results:

•   Use a single first-level heading for the post title. This works best if the title is short enough and fits within a single line in the card rendered by Google+.

•   Use second-level headings to separate the different sections of your post. You can go use further nesting levels, but you won't be able to tell them apart in the final version.

•   Links are supported by emitting the target URL after the link text. Do not be too smart with the link labels because they won't be clickable.

FILES

~/.config/markdown2social.conf
    Default configuration file.

EXIT STATUS
markdown2social returns 0 on success and non-zero on failure.

SEE ALSO
markdown2social.conf(5)