[Draft] Test commit to preview the man page #21194
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bookwar
force-pushed
the
markdown-test
branch
from
8717d18
to
3f93680
Compare
bookwar
commented
Oct 30, 2024
| .SH "BUGS" | ||
| .sp | ||
| Please send bug reports to either the distribution bug tracker or the | ||
| .URL "https://github.com/cockpit\-project/cockpit/issues/new" "upstream bug tracker" "." |
There was a problem hiding this comment.
This is the raw output of asciidoctor.
It renders URL correctly in the man markup using .URL keyword.
| e. | ||
| the path component of Cockpit URLs. | ||
| It is highly recommended to only open a particular page | ||
| frame (https://cockpit-project.org/guide/latest/embedding.html), not the |
There was a problem hiding this comment.
This is the render of markdown input produced by pandoc.
Url is written as a plain text, thus line breaks can happen in the middle of it.
| @@ -0,0 +1,59 @@ | |||
| % cockpit-desktop(1) | Cockpit Desktop integration | |||
| @@ -0,0 +1,59 @@ | |||
| = cockpit-desktop(1) | |||
| :doctype: manpage | |||
There was a problem hiding this comment.
This is the doc-type to use for man pages backend in asciidoctor
https://docs.asciidoctor.org/asciidoctor/latest/manpage-backend/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Testing GitHub presentation of Markdown and Asciidoc for man pages
To generate man page from markdown run:
To generate man page from asciidoc run
To view man page run: