Trivial commit that fixes Markdown line breaks in docs/init.md. Markdown line breaks take the form of two spaces, which is hard to spot when viewing raw text but visible when previewing on GitHub. Line 72-73 of docs/init.md did not conform to the rest the rest of the documentation, and is corrected in this PR.
Docs: Fix Markdown formatting issues in init.md #10878
pull dongcarl wants to merge 2 commits into bitcoin:master from dongcarl:patch-1 changing 1 files +14 −14-
dongcarl commented at 4:19 AM on July 19, 2017: member
-
Update init.md: Fix line breaks in section 3b. 72a184a780
- dongcarl renamed this:
Docs: Fix markdown line breaks in init.md
Docs: Fix Markdown line breaks in init.md
on Jul 19, 2017 -
practicalswift commented at 7:59 AM on July 19, 2017: contributor
ACK 72a184a780f29d7833d900d728c0c3a10f460969
-
jonasschnelli commented at 8:42 AM on July 19, 2017: contributor
ACK 72a184a780f29d7833d900d728c0c3a10f460969
- jonasschnelli added the label Docs and Output on Jul 19, 2017
- promag approved
-
promag commented at 2:57 PM on July 19, 2017: member
ACK 72a184a.
-
laanwj commented at 11:46 AM on July 27, 2017: member
This whole file looks strange in the github renderer: https://github.com/dongcarl/bitcoin/blob/72a184a780f29d7833d900d728c0c3a10f460969/doc/init.md
For example, it doesn't quite catch the section headers.
-
dongcarl commented at 12:17 PM on July 27, 2017: member
@laanwj Right. There's the option to use "##", but then it wouldn't look as nice in plain text. I'm sure it's a glitch in the renderer.
Another question: I want to expand on Section 3 (Paths), and give example cli commands in different UNIX distros to do things described in the section such as:
- Create bitcoin user and group (with optional flag to disable home directory creation)
- Make PID and data directory owned by bitcoin user and group
- Make configuration file and data directory only readable by bitcoin user and group
Shall I add on to this PR or keep this PR just about Markdown formatting?
-
laanwj commented at 3:01 PM on July 27, 2017: member
Right. There's the option to use "##", but then it wouldn't look as nice in plain text. I'm sure it's a glitch in the renderer.
---------------works ok for defining titles in other files, the reason might be that the titles are prefixed with a number and a dot.Shall I add on to this PR or keep this PR just about Markdown formatting?
My opinion would be that it's best to limit this one to fixing formatting issues.
-
flack commented at 9:27 PM on July 27, 2017: contributor
@laanwj
-------works for headlines, but it's not anything mentioned in github's documentation, more like cmpatibility to the old Daring Fireball specification. Right now, the headlines with numbers get rendered as<ol>tags, so my guess would be that the parser goes through the document line by line and when it matches the list syntax, it doesn't look for headlines any more, but instead treats the----as a new element which gets rendered as<hr>. There are two ways around it:- Use
#:
[#1](/bitcoin-bitcoin/1/). Service User- Escape the
.character:
1\. Service User ----------------Although it's kind of hard to decide which one is less ugly :-)
Alternatively, why not write
1: Service User ----------------instead?
- Use
-
laanwj commented at 6:17 AM on July 28, 2017: member
In none of the other documents we have section numbering, so it would also be ok to remove the numbers completely, at least assuming they're not used to reference anything.
-
Update init.md: Fix section numbering. d201e40c55
-
dongcarl commented at 4:21 PM on July 28, 2017: member
- dongcarl renamed this:
Docs: Fix Markdown line breaks in init.md
Docs: Fix Markdown formatting issues in init.md
on Jul 28, 2017 -
dongcarl commented at 5:51 PM on July 28, 2017: member
Travis failed on something unrelated to the docs... My changes shouldn't have broken anything.
-
laanwj commented at 7:56 AM on August 18, 2017: member
ACK d201e40
My changes shouldn't have broken anything.
Yup. Welcome in the world of automated testing :/
- laanwj merged this on Aug 18, 2017
- laanwj closed this on Aug 18, 2017
- laanwj referenced this in commit c58128f189 on Aug 18, 2017
- PastaPastaPasta referenced this in commit efa20ca624 on Sep 19, 2019
- PastaPastaPasta referenced this in commit 01c72d3529 on Sep 23, 2019
- PastaPastaPasta referenced this in commit 1e95d0570a on Sep 24, 2019
- PastaPastaPasta referenced this in commit 6276dd66eb on Nov 19, 2019
- PastaPastaPasta referenced this in commit 6e72dc41af on Nov 21, 2019
- PastaPastaPasta referenced this in commit 01b03ac2d1 on Dec 9, 2019
- PastaPastaPasta referenced this in commit 4b3ec1131a on Jan 1, 2020
- PastaPastaPasta referenced this in commit 95e494983c on Jan 2, 2020
- ckti referenced this in commit 7b14b25803 on Mar 28, 2021
- DrahtBot locked this on Sep 8, 2021