Markdown Formatting

nick's Avatar

nick

13 Feb, 2020 04:19 PM

I am curious about markdown formatting behavior I am seeing while using Marked but it doesn't seem to render the same if/when I upload the file to github. Below is what I have in my document and i attached an image of what it looks like in Marked (img1) and then what i see in github (img2). Let me know if i am doing something wrong, if this is unsupported, or other. Thanks.

 1. Change bridge connections from 30 to 60
- Required object spawner restart

2. Update metadata SASApp Stored Process Server Load Balancing options
- Maximum Cost = 500
- Start size = 60

3. server.xml changes

 server1 server.xml
- maxThreads = 1024 (no change)
- acceptCount = 100
  1. 1 Posted by nick on 13 Feb, 2020 04:48 PM

    nick's Avatar

    I had gotten this to function a bit better, and certainly seems it has to do with how I am writting this out. I think the root of the problem was how I had the start of the number list right up next to another item, as you can see in the image, I added a return after the "summary of changes". Do still have to figure out how to revisit the number list since it tries to take #4 and wrap it as a bullet list inline.

  2. nick closed this discussion on 13 Feb, 2020 04:50 PM.

  3. Brett re-opened this discussion on 13 Feb, 2020 08:54 PM

  4. Support Staff 2 Posted by Brett on 13 Feb, 2020 08:54 PM

    Brett's Avatar

    If in doubt, always add whitespace around block items like code, lists, blockquotes, etc. Also, it appears you're actually trying to make sub-lists with the unordered lists, but they're not indented (unless something got shifted in the paste). They should be indented 4 spaces to function correctly and not break the rest of the list.

    Looking at it I have to assume it lost formatting, though, as the line server1 server.xml looks like it should have been a code block? In which case it would need to indent 8 spaces. Oh, and that will be another source of confusion, Marked prefers 4 spaces for list indentation whereas github will let you get away with 2. Using 4 will work in both places, though.

  5. 3 Posted by nick on 13 Feb, 2020 09:03 PM

    nick's Avatar

    Thanks Brett - I feel bad how there are likely times you are fielding markdown newbie questions as opposed to product related issues. Both your points are keys to getting this to work. I also had a line "header if you will" without a return directly before the number list which seemed to affect the rest of the series down stream. Then additional indentation is what had everything looking as I expected. The image was my working result.

    This has been great in the few hours I've been working with Marked. I write everything in VIM and Marked has added a nice visual touch with many wonderful features. Sorry for the noise!

  6. Support Staff 4 Posted by Brett on 13 Feb, 2020 09:22 PM

    Brett's Avatar

    Yeah, that looks much better!

    I'd say that 80% of my customer support is correcting people's Markdown, but it's no sweat :). Glad to hear Marked is proving useful!

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:

»

Already uploaded files

  • img1.jpg 80.2 KB
  • img2.jpg 93.7 KB

Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac