Skip to content

Commit

Permalink
Improve the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mkende committed May 17, 2024
1 parent 5a8683a commit 10796bd
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 14 deletions.
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ This software supports the entire
some more custom extensions. It also has compatibility with the
[original Markdown syntax](https://daringfireball.net/projects/markdown/syntax).

It is based on the [Markdown::Perl](https://metacpan.org/pod/Markdown::Perl)
library that can be used in standalone Perl program.

See the [Syntax page](Syntax.md) for a full description of the default syntax
supported by `pmarkdown`.
supported by `pmarkdown`. You can also
[try it out online](https://dingus.mkdoc.io/) or compare it to other
implementations by using [Babelmark](https://babelmark.github.io/).

This program is based on the
[Markdown::Perl](https://metacpan.org/pod/Markdown::Perl) library that can be
used in standalone Perl programs.

## Usage

Expand All @@ -38,35 +41,37 @@ You can download portable versions of `pmarkdown` for Windows and Linux on the
### Installation from the Perl package manager

To install `pmarkdown` you need Perl (which is already installed on most Linux
distributions) and you need the `cpanm` Perl package manager. You can usually
get both with one of these commands:
distributions) and you need the `cpanm` Perl package manager. In addition, the
`perl-doc` program is optional but will improve the display of the program
documentation. You can usually get them with one of these commands:

```shell
# On Debian, Ubuntu, Mint, etc.
sudo apt-get install perl cpanminus
sudo apt-get install perl cpanminus perl-doc

# On Red Hat, Fedora, CentOS, etc.
sudo yum install perl perl-App-cpanminus
sudo yum install perl perl-App-cpanminus perl-doc
```

Then run the following to install `pmarkdown`:

```shell
cpanm --notest App::pmarkdown
sudo cpanm App::pmarkdown -n -L /usr/local --man-pages --install-args 'DESTINSTALLBIN=/usr/local/bin'
```

### Installation from the Git sources

To install `pmarkdown` you need Perl (which is already installed on most Linux
distributions) and you need the `cpanm` Perl package manager. You can usually
get both with one of these commands:
distributions) and you need the `cpanm` Perl package manager. In addition, the
`perl-doc` program is optional but will improve the display of the program
documentation. You can usually get them with one of these commands:

```shell
# On Debian, Ubuntu, Mint, etc.
sudo apt-get install perl cpanminus
sudo apt-get install perl cpanminus perl-doc

# On Red Hat, Fedora, CentOS, etc.
sudo yum install perl perl-App-cpanminus
sudo yum install perl perl-App-cpanminus perl-doc
```

Then run the following command to install `pmarkdown` (note that you do not need
Expand All @@ -80,3 +85,7 @@ perl Makefile.PL
make
sudo make install
```

Note that, with this installation method, you might need to reinstall the
program each time your system Perl is updated. So the methods above are
recommended.
2 changes: 1 addition & 1 deletion Syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ Is rendered as:

The rendering of these delimited spans can be tuned with the `inline_delimiters`
option, which allows to specify arbitrary tags to generate for a given delimiter
(and can also be used to generate C<< <span> >> with arbitrary classes).
(and can also be used to generate `<span>` with arbitrary classes).

### Links

Expand Down
2 changes: 2 additions & 0 deletions script/pmarkdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ use strict;
use warnings;
use utf8;

use lib '/usr/local/lib/perl5'; # To be used together with the cpanm command given in the README.md file.

use Encode;
use Encode::Locale 'decode_argv';
use English;
Expand Down

0 comments on commit 10796bd

Please sign in to comment.