Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sshaw/output-as-format
Output stdin as GitHub/Slack/Jira etc... formatted code, lists, or quotes
https://github.com/sshaw/output-as-format
bitbucket command-line-tool disqus github gitlab hipchat html jira markdown mediawiki org-mode perl pod restructuredtext slack vim
Last synced: about 2 months ago
JSON representation
Output stdin as GitHub/Slack/Jira etc... formatted code, lists, or quotes
- Host: GitHub
- URL: https://github.com/sshaw/output-as-format
- Owner: sshaw
- Created: 2017-03-03T05:59:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-30T00:17:14.000Z (about 4 years ago)
- Last Synced: 2024-01-27T17:04:04.625Z (5 months ago)
- Topics: bitbucket, command-line-tool, disqus, github, gitlab, hipchat, html, jira, markdown, mediawiki, org-mode, perl, pod, restructuredtext, slack, vim
- Language: Perl
- Homepage: https://metacpan.org/pod/App::oaf
- Size: 32.2 KB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.pod
- Changelog: Changes
Lists
- awesome - output-as-format - Output stdin as GitHub/Slack/Jira etc... formatted code, lists, or quotes (Perl)
- cli-apps - Output as Format - Output stdin as GitHub/Slack/Jira etc... formatted code, lists, or quotes. (<a name="text-processing"></a>Text processing)
- awesome-cli-apps - Output as Format - Output stdin as GitHub/Slack/Jira etc... formatted code, lists, or quotes. (<a name="text-processing"></a>Text processing)
README
=pod
=head1 NAME
App::oaf - Output stdin as a GitHub/Slack/Jira etc... formatted code, list, or quote
=head1 SYNOPSIS
Output as Format will read from stdin and output code, lists, or quotes
based on the provided options and/or environment variables.
usage: oaf [-1mpsLQ] [-f format] [-l lang] [--list[1]] [--quote]
Output stdin according to the given options
-f FORMAT Format to output, defaults to markdown
-h, --help Display this message
-l LANG Programming language of stdin, if supported by FORMAT
-L, --list Output a bullet point list using FORMAT, each line is a list item
-1, --list1 Output a numbered list using FORMAT, each line is a list item
-m Force multiline output, if supported by FORMAT
-p Print the supported formats and exit
-Q, --quote Output as a quote in FORMAT
-s Force single line output, if supported by FORMAT
--version Print the version
=head1 EXAMPLES
Output as GitHub Flavored Markdown:
cat some-code | oaf -f github -l perl
```perl
my $n = foo();
return unless $n > 100;
```
Output as MediaWiki:
cat some-code | oaf -f mediawiki -l perl
my $n = foo();
return unless $n > 100;
Output a Markdown list:
echo -e "line1\nline2\nline3" | oaf --list
* line1
* line2
* line3
Output a numbered list formatted for JIRA:
echo -e "line1\nline2\nline3" | oaf --list1 -f jira
# line1
# line2
# line3
Output a quote formatted for Org mode:
echo -e "line1\nline2\nline3" | oaf --quote -f orgmode
#+BEGIN_QUOTE
line1
line2
line3
#+END_QUOTE
=head1 INSTALLATION
Currently there are two ways to install.
This requires your system to have L installed.
Unless you're on Windows you probably have it (here in 2019).
=head2 Download
curl -o oaf https://raw.githubusercontent.com/sshaw/output-as-format/master/oaf
chmod 555 oaf
=head2 CPAN
cpan App::oaf
=head1 SUPPORTED FORMATS & SERVICES
=over 2
=item * Bitbucket
=item * Disqus
=item * GitHub
=item * GitLab
=item * HipChat
=item * HTML
=item * JIRA
=item * Markdown
=item * MediaWiki
=item * Org-mode
=item * POD
=item * reStructuredText
=item * Slack
=back
=head1 DEFAULTS
Defaults can be set by the following environment variables:
=over 2
=item * C - output format
=item * C - input programming language
=back
The default format is Markdown. There is no default programming language.
=head1 AUTHOR
Skye Shaw (sshaw [AT] gmail.com)
=head1 SEE ALSO
L for Emacs, from which
this is based.
=head1 COPYRIGHT
Copyright (c) 2017-2019 Skye Shaw.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.