cli-microsoft365: Bug report: Make sure pipes are escaped in .md files

Description

If pipe ‘|’ is used in markdown without being escaped like ‘|’, the pipe and the following text will not render

Steps to reproduce

See https://github.com/pnp/office365-cli/blob/master/docs/manual/docs/cmd/aad/o365group/o365group-set.md

Expected result

"Output type. json|text

Actual result

"Output type. `json "

Environment

N/A

About this issue

Original URL
State: closed
Created 4 years ago
Comments: 20 (14 by maintainers)

Commits related to this issue

Fixes 'pipe' change to 'comma' in the docs. Closes #1420 — committed to VelinGeorgiev/office365-cli by deleted user 4 years ago
Replaces '|' (pipe) with ',' (comma) in the docs. Closes #1420 — committed to pnp/cli-microsoft365 by deleted user 4 years ago

Most upvoted comments

Thanks for bearing with us @jhagstrom. For now, let’s use commas, like you’ve done in the PR. We can always reconsider, should there be a newer version of MkDocs with additional capabilities.

waldekmastykarz on Apr 3, 2020

All right, then let’s agree on using |.

waldekmastykarz on Mar 30, 2020

@jhagstrom after my research last night, there is no alternative GFM parser for MKDocs, there is one that I found but it had way too many limitations listed to really consider it.

I’d love to see the docs retain the use of pipe but I see @waldekmastykarz point, happy to reconsider.

garrytrinder on Apr 2, 2020

I’ll check it out. I tried replacing the escaped pipe with the html encrypted thing, but it doesn’t render in github md for me now so I think I didn’t do it right.

jhagstrom on Apr 2, 2020

Nope. Whatever you prefer.

VelinGeorgiev on Mar 30, 2020