Bulleted list not working
I am trying to edit a readme file on github, however, the bulleted list is not being formatted correctly. The theme is set to github.css. Any ideas why I am seeing this?
Thank you,
Sasha
P.S. For some reason I failed to attach the file with the screenshot. It is here
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
Support Staff 1 Posted by Brett on Oct 28, 2013 @ 12:25 PM
MultiMarkdown (and standard Markdown) require 4 spaces or one tab to indent a list item. GitHub relaxes that requirement, so it renders differently. If it’s problematic to use 4 spaces for any reason, you can add a preprocessor to adjust it or use a custom processor to render with something like Kramdown or Maruku, which should fix the issue for you as well.
-Brett
2 Posted by sasha on Oct 28, 2013 @ 12:30 PM
Yep, this works! The many flavors of markdown are confusing.
Thank you,
Sasha
3 Posted by sasha on Oct 28, 2013 @ 12:34 PM
The other issue I noticed in the same example is that github uses underscores to make a word italict (see "species") in the readme. I couldn't get github to do bold italic another way (although I didn't try very hard). However, this is not formatted in the same way as github by marked, which keeps the underscores.
Sasha
Support Staff 4 Posted by Brett on Oct 28, 2013 @ 05:58 PM
It shouldn’t, underscores and asterisks are entirely interchangeable. `_**Italic Bold**_` should work fine. Can you show me a snippet of what your syntax looks like?
5 Posted by sasha on Oct 28, 2013 @ 10:52 PM
* trim_hiseq2500.sh and trim_hiseq2000.sh
- cut low quality sequence and move files to their respective folders from the OIST sequencing center folder.
- the two different files correspond to the two runs
* concatenate.sh
- collect all the trimmed files into one set of input files
* abyss.sh
- runs a range of k-mers for assembly
- these should be invoked with **qsub -v NAME=_species_**
Support Staff 6 Posted by Brett on Oct 28, 2013 @ 10:58 PM
Github syntax is designed to allow underscores within words to _not_ be interpreted as italics, especially if the opening underscore has a character touching it on the left. You’re best off using asterisks if you want bold italics.
-Brett
7 Posted by sasha on Oct 28, 2013 @ 11:14 PM
However, if I do nested asterisks, like:
**qsub -v NAME=*species***
In any case, I think it it would be really nice to have a viewer that works just like github, rather than adapting my writing style to work for github and marked.
Sasha
Support Staff 8 Posted by Brett on Oct 28, 2013 @ 11:26 PM
Github uses a proprietary renderer (Github Flavored Markdown) that isn’t easily embedded into Marked. If I make Marked support GFM, it then changes expected behavior for longtime Markdown users. That’s why I built in the Custom Processor feature, though. You can use any processor you want (e.g. https://github.com/alampros/Docter) to get exact Github rendering.