pagure

#1309 [Docs] Write page for Pagure-style Markdown rules
Closed: Fixed Opened by jflory7.

Closed: Fixed
Reopen Issue

Summary

Add a dedicated page for Markdown formatting rules in Pagure (first discussed in #1296).

Analysis

The markdown syntax page isn't comprehensive to all styles of Markdown used in Pagure, and I also understand that Pagure has some custom forms of Markdown or formatting that make it different too. Having a dedicated, local document for Pagure that explains the different markdown syntax available would be helpful to communicate the different formatting options available.

I have volunteered to contribute this doc.

Implementation

  1. Understand where Pagure Markdown rules are described / defined in the code, compare to general markdown
  2. Write document based off of general markdown + Pagure markdown that explains usage and examples (something with examples like GitHub's page
  3. Submit pull request…

If someone wants to assign this issue to me, I'd be happy to take it on (I don't have privileges to self-assign issues).

PR #1431 addresses this issue.

The PR is great. However, two things I was trying to do are a) relative links in a repo b) footnotes. Are these supported in the MD engine in use? Or should I file separate issues to request support?

@langdon Not sure I follow what you mean by relative links – like linking to a local file in the repository, e.g. doc/usage/markdown.md links to the Markdown rules?

@pingou #1431 addressed this and was merged. I think this issue is good to close. :clapper:

Let's close then :)

Metadata Update from @pingou:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)
Metadata
None
None
None
None
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.