RetroPie forum home
    • Recent
    • Tags
    • Popular
    • Home
    • Docs
    • Register
    • Login

    Inconsistency Between Wiki and Docs Formatting

    Scheduled Pinned Locked Moved Ideas and Development
    wikidocs
    3 Posts 2 Posters 1.2k Views
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • obsidianspiderO
      obsidianspider
      last edited by

      I was looking at the docs section when refering to a post and I noticed that the formatting is different between the Wiki and the Docs area. I'm not sure if anything can be done, but if you look at the "Alternate USB Audio" part I edited a few days ago the code blocks don't show up the same and the numbering of the steps resets after each code block on the Docs area where in the wiki it doesn't.

      📷 @obsidianspider

      herb_fargusH 1 Reply Last reply Reply Quote 1
      • herb_fargusH
        herb_fargus administrators @obsidianspider
        last edited by

        @obsidianspider There are some nuances with the github flavoured markdown vs the python markdown the pretty docs parser uses. the python markdown is actually closer to the commonmark standard and will still render in the github wiki (for the most part)

        I've written up an editing guide with some standards so that they will translate as cleanly as possible. some concessions have to be made but for all intents and purposes I think the majority of the wiki pages should be able to be adapted to it if there are conflicts.

        https://github.com/RetroPie/RetroPie-Docs/wiki/Editing-the-Wiki

        If you read the documentation it will answer 99% of your questions: https://retropie.org.uk/docs/

        Also if you want a solution to your problems read this first: https://retropie.org.uk/forum/topic/3/read-this-first

        obsidianspiderO 1 Reply Last reply Reply Quote 1
        • obsidianspiderO
          obsidianspider @herb_fargus
          last edited by

          @herb_fargus Thanks! I'll go back and clean things up a bit!

          📷 @obsidianspider

          1 Reply Last reply Reply Quote 0
          • First post
            Last post

          Contributions to the project are always appreciated, so if you would like to support us with a donation you can do so here.

          Hosting provided by Mythic-Beasts. See the Hosting Information page for more information.