I'm writing a README.md for one of my repositories on github.com.
As part of this README.md I'd like to include a quote of another README.md (from another repository), which implies using advanced markdown inside the quote.
Eventually I'd like to see something like this:
Item 1
Use the following:
First level of quoted list
Second level of quoted list
Nested quote
Item 2
For now I'm trying to achieve this with the following markdown:
* Item 1
* Use the following
> * First level of quoted list
> * Second level of quoted ***list***
> * > Nested *quote*
* Item 2
There are several online markdown editors out there that intend to simulate github markdown behavior: ones that work much better than github itself, others that are a bit more realistic, but in github it looks like this:
Item 1
Use the following
> * First level of quoted list > * Second level of quoted list > * > Nested quote
Item 2
So it appears that github supports some simple markdown inside the block quote (like bold, italic etc.), but it won't support the advanced markdown (like lists, quotes etc.)
Is there any way to quote a complex markdown on github?
GitHub is picky about requiring blank lines (to create a new pagragraph) before starting a blockquote. This seems to do what you want:
* Item 1
* Use the following
> * First level of quoted list
> * Second level of quoted ***list***
>
> * > Nested *quote*
* Item 2
Related
I'm creating README.md file for my Repo in github, but i cant indent the code blocks as much as my list items has indent from the left, I'm trying as bottom and i want this block of code to start with indention of list items.
* list
* Item one
* ``` codes here..```
also it didn't worked :( don't know why.
Skip a line and indent eight spaces. Eight spaces will trigger the code block.
List
Item one
This is
a code block
I had to manually indent these lines
Item three
The above is the output of
* List
* Item one
* ```
This is
a code block
I had to manually indent these lines
```
* Item three
Does this help?
You need to add blank lines to make it work with the 8 spaces. Now because your item one is already 4 spaces in you need to add 12 spaces (4 + 8 = 12) like so
* list
* item one
codes here..
Which will then look like:
list
item one
codes here..
I am using bbedit 12 in a markdown document.
I have enabled Soft Wrap Text at Page Guide as it makes the document easier to read.
As can be expected, itemised lists looks like this:
* some reallllllly long
text
* and another loooooong
paragraph
but I would like them to be shown as follow:
* some reallllllly long
text
* and another loooooong
paragraph
Is there a setting to indent the lines in one item on the display?
Thanks.
The Reverse option for soft-wrapped line indentation seems to work for me. But I don't completely understand how it operates, so it may not work in all cases.
The GitHub markdown code:
1. First item
* subitem
1. Second item
Generates a big space between the First, Second and the subitem:
How to make the subitem close to the first item, instead of exactly on the middle of them?
This is a Photoshop I did to illustrate the correct output:
Related questions:
Multi paragraph list items, OR preventing numbered list auto formatting
Markdown: Problems with numbered list paragraphs containing code element
You need to indent the sublist with at least 4 spaces:
1. First item
* subitem
2. Second item
You cannot do this going from a primary to secondary item. It is possible from a secondary to tertiary list, however. This is due to GitHub's styling of the markdown, not an inherent issue with the markdown itself.
See this document for details on what is possible regarding different layout styles.
An admittably "hacky" but still working solution:
Choose any character from here.
Copy it and paste it as bullet point:
1. First item [< two spaces for the linebreak]
◦ subitem1 [< two spaces for the linebreak]
◦ subitem2
2. Second item
Don't forget the two spaces for the linebreak.
* Parent
Some text under this level
** Headline below parent
** Another Headline at the same level
I don't want this text to be a headline but be indented same as the text under the parent level without being a headline. Cannot do this.
I just cannot re-indent this text just below the parent level here
* Another top-level headline
Is there any way in org-mode to re-indent plain text back to the same indent level as the plain text just under the parent level but below several headlines under the parent?
I am trying to do something like this:
* A Section
Introductory text.....
** Subsection 1
** Subsection 2
Further Reading
Now, that "Further Reading" is not a headline, I don't want it to be one. However, I cannot "get out of" Subsection 2: Anything I type below it is a part of it. Perhaps I need to structure this some other way such as using lists instead of headlines.
There is no way to do this in org, currently - there is no syntax that ends a subheader to return you to the previous level. But you could add a subsection at the same level - e.g. in your example,
* A Section
Introductory text.....
** Subsection 1
Subsection 1 text
** Subsection 2
Subsection 2 text
** Further Reading
Some further reading
It might be nice if org had some syntax, like **-, that would end a subsection, but I'm not sure how involved a change that would be - probably pretty extensive.
In Eclipse, I can format comments by selecting them and pressing Shift + Ctrl + F. For example, when I select a method comment like this:
/**
* This method
* does some stuff.
*/
and press Shift + Ctrl + F, Eclipse automatically wraps it:
/**
* This method does some stuff.
*/
Is there anything comparable to this in IDEA?
EDIT: To clarify, I'm looking for comment formatting that also breaks lines that are too long into multiple lines.
The closest thing that you can get is Edit | Join Lines (Ctrl+Shift+J). You have to select the lines you want to join first.
To wrap long comments enable Settings | Code Style | JavaDoc | Wrap at right margin.
For Javadoc comments, you want to make sure the "Wrap at right margin" setting is checked. See Code Style > JavaDoc, under "Other". However, this setting only seems to take effect when you reformat the whole file, since a reformat of just the Javadoc (i.e., select the Javadoc, then do a Code (menu) > Reformat Code... or CtrlAltL) that exceeds the right margin doesn't force it to wrap. If I reformat the entire file, then it wraps at the margin as expected.
This seems like a bug (though one that doesn't seem to have been reported), since if you have to set the "Ensure right margin is not exceeded" checked, then selecting the Javadoc text and doing a reformat code does indeed wrap the lines. This setting is in Settings > Code Style > Wrapping and Braces. You can also do a search in the Settings dialog for "ensure right margin".
You'll still have to manually join the lines using CtrlShiftJ
This might be worthy of an improvement request to JetBrains.
Existing comment will be reformatted when you do "Reformat Code" (⌥⌘L in Mac).
#kghastie uncovered the key.
Steps:
Set the Code Style > Java > JavaDoc > Wrap at right margin setting.
Select the full lines of the entire JavaDoc comment.
Reformat Code (Ctrl-Alt-L or ⌥⌘L).
Lesser alternative:
Set the Code Style > Java > JavaDoc > Wrap at right margin setting and the Code Style > Java > Wrapping and Braces > Ensure right margin is not exceeded setting.
Select some text within a JavaDoc comment.
Join Lines (Ctrl-Shift-J) followed by reformat Code (Ctrl-Alt-L or ⌥⌘L).
Beware: This will leave all the selected lines joined even where you had paragraph breaks (<p/> or \n\n).
The JetBrains plugin Wrap to Column is made for this:
From the overview:
Wraps text to the specified column width. Similar to the Emacs command 'Fill Paragraph' and Vim's gq (format lines) command. This is a replacement for the native Intellij Fill Paragraph command, which doesn't work quite how I need it to.
This plugin provies two IDE actions:
Wrap Line to Column: Wraps selected text or the current line if no text is selected. This is useful for IdeaVim users who wish to pair the command with motions like vip (select current paragraph).
Wrap Paragraph to Column: Wraps the paragraph (multiple lines) in which the cursor appears. No selection is needed, and will be ignored.
I'm using IntelliJ 14 on a Mac, which has a Fill Paragraph command. Access it via the awesome universal Command-Shift-A action search feature. Works like a charm!
This is a hack, not a really good solution, but if you have a block of code that you want formatted like this and it's in serious need of auto format, because it's going over the 80 line max, or it's just unreadable...
You can just put if ("foo" == "bar") { on top of whatever you want formatted, and then and the} at the bottom of the if statement, to close it, and voila, your code should auto-indent, auto format, etc... Then take it out, highlight all of what you just formatted and press SHIFT+TAB to move it back 4 spaces and remove the dummy if statement