#1431 Add documentation for using Markdown in Pagure (fixes #1309)
Merged by pingou. Opened by jflory7.
jflory7/pagure add/markdown_docs  into  master

Download 1431.patch

Summary

This pull request adds documentation for how to use Markdown inside of Pagure.

Description

This closes out #1309 for writing documentation about using Markdown within Pagure. The purpose of this pull request is to link it internally within Pagure instead of pointing people to this external website (which lacks some unique Markdown elements within Pagure). This page can be updated or maintained over time if new, unique formatting is added into Pagure.

Admittedly, I did borrow greatly from the GitHub page for this, but it still is different.

Example

An example of the provided markdown file can be found here.

You can also use ~~~~ for multi-lines

For cross-projects links you can do <project name>#id or <username>/<project name>#id

We should point to this doc in the usage.rst file otherwise it won't appear in the doc

Other than this, a couple of possible improvements and we should be good to go :)

LGTM.

1 new commit added

  • Include cross-project tagging in markdown doc

1 new commit added

  • Include reference to markdown.md in usage.rst

@pingou Here's two new commits that mention cross-project tagging and also includes this doc in the usage.rst file. However, I tried using the ~~~~ in the doc, but when I pushed to Pagure, this was not visible in my test repository.

For the ~~~~ needs to be alone on the line, something like:

~~~~
foo bar
~~~~

And as you can see we also support four ` marks :)

@pingou Hmm, perhaps does this only display right in comments? I tried again on that test repo and got the same result (see raw file). It also seems like the four ` marks do not preserve line breaks. Am I doing something wrong there?

testing()
this.thing.test()

Hm, there seems to be a difference between comments and files, let me check the code so we are consistent

Ok indeed we're not using the same code, let me fix this :)

ok I hotfixed stg so the markdown for files go through the same code as the one used in comments, it will require a few adjustments to the file though.

@pingou Awesome! This last commit should have everything fixed up now. My staging repository has the latest commit as the rendered file.

1 new commit added

  • Update file based on hotfix to staging, update documentation for code blocks

Cool!
Mind to rebase? Then let's merge :)

rebased

@pingou Not sure if I did this right… is this what you meant?

Nope, it looks like you merged instead of rebasing.

To rebase try using either: git pull --rebase or pull to master so it's up to date with what's in he main pagure repo then in your branch git rebase master

Feel free to ping me on IRC if you need/want help

rebased

@pingou Okay, I think I got it now. :)

Looks like it may need a little clean up :D

1 new commit added

  • Let's try this one more time (fix merge issues)

@pingou Whoops… that's not what I remember committing. Anyways, this last commit should fix that, and I checked to be sure this time. :P Anyways, hopefully I'm done wasting your time from here on, let me know if there's anything else you need from me on this one!

Looks great, thanks!

Pull-Request has been merged by pingou

Metadata