Commit 0e360214a1da2c4b4dda2b2b94e6230b1dd8649d
Merge pull request #41 from ssbc/adding-markdown-guide
Added new question around markdownZach Mandeville authored on 5/10/2017, 4:22:52 AM
GitHub committed on 5/10/2017, 4:22:52 AM
Parent: 1ad96a46ee28939dff2268346c21c638648ab318
Parent: e855ead11ea5b2c532df555668d91e2f3f5caedf
Files changed
faq/applications/applications.md | changed |
faq/applications/patchwork-markup.md | added |
faq/index.md | changed |
faq/applications/applications.md | ||
---|---|---|
@@ -5,4 +5,5 @@ | ||
5 | 5 … | |
6 | 6 … | - [If I am on Patchwork, can I see what my friends post on Patchbay?](patchwork-and-patchbay.md) |
7 | 7 … | - [If I decide to move from one Scuttlebutt app to another, can I keep my feed and history? ](moving-ssb-apps.md) |
8 | 8 … | - [Can I use scuttlebutt on different devices, but maintain the same identity? (For example: updating my Patchwork feed from my home or work computer?)](multiple-devices.md) |
9 … | +- [Is there a markdown guide for Patchwork?](patchwork-markup.md) |
faq/applications/patchwork-markup.md | ||
---|---|---|
@@ -1,0 +1,91 @@ | ||
1 … | +# Is there a list of possible markdown for Patchwork? | |
2 … | + | |
3 … | +*Patchwork messages can be written with markdown, but what specific flavor or dialect of markdown? I want a style guide!* | |
4 … | + | |
5 … | +--- | |
6 … | +Here you go! | |
7 … | + | |
8 … | + *** | |
9 … | + Emphasis, aka italics, with *asterisks* or _underscores_. | |
10 … | + | |
11 … | + Strong emphasis, aka bold, with **asterisks** or __underscores__. | |
12 … | + | |
13 … | + Combined emphasis with **asterisks and _underscores_**. | |
14 … | + | |
15 … | + Strikethrough uses two tildes. ~~Scratch this.~~ | |
16 … | + | |
17 … | + 1. First ordered list item | |
18 … | + 2. Another item | |
19 … | + * Unordered sub-list. | |
20 … | + 1. Actual numbers don't matter, just that it's a number | |
21 … | + 1. Ordered sub-list | |
22 … | + 4. And another item. | |
23 … | + | |
24 … | + Some text that should be aligned with the above item. | |
25 … | + | |
26 … | + * Unordered list can use asterisks | |
27 … | + - Or minuses | |
28 … | + + Or pluses | |
29 … | + | |
30 … | + [I'm an inline-style link](https://www.google.com) | |
31 … | + | |
32 … | + [I'm a reference-style link][Arbitrary case-insensitive reference text] | |
33 … | + | |
34 … | + [You can use numbers for reference-style link definitions][1] | |
35 … | + | |
36 … | + Or leave it empty and use the [link text itself] | |
37 … | + | |
38 … | + URLs and URLs in angle brackets will automatically get turned into links. | |
39 … | + http://www.example.com or <http://www.example.com> and sometimes | |
40 … | + example.com (but not on Github, for example). | |
41 … | + | |
42 … | + Some text to show that the reference links can follow later. | |
43 … | + | |
44 … | + arbitrary case-insensitive reference text]: https://www.mozilla.org | |
45 … | + [1]: http://slashdot.org | |
46 … | + [link text itself]: http://www.reddit.com | |
47 … | + | |
48 … | +The above yields: | |
49 … | + | |
50 … | +Emphasis, aka italics, with *asterisks* or _underscores_. | |
51 … | + | |
52 … | +Strong emphasis, aka bold, with **asterisks** or __underscores__. | |
53 … | + | |
54 … | +Combined emphasis with **asterisks and _underscores_**. | |
55 … | + | |
56 … | +Strikethrough uses two tildes. ~~Scratch this.~~ | |
57 … | + | |
58 … | +1. First ordered list item | |
59 … | +2. Another item | |
60 … | + * Unordered sub-list. | |
61 … | +1. Actual numbers don't matter, just that it's a number | |
62 … | + 1. Ordered sub-list | |
63 … | +4. And another item. | |
64 … | + | |
65 … | + Some text that should be aligned with the above item. | |
66 … | + | |
67 … | +* Unordered list can use asterisks | |
68 … | +- Or minuses | |
69 … | ++ Or pluses | |
70 … | + | |
71 … | +[I'm an inline-style link](https://www.google.com) | |
72 … | + | |
73 … | +[I'm a reference-style link][Arbitrary case-insensitive reference text] | |
74 … | + | |
75 … | +[You can use numbers for reference-style link definitions][1] | |
76 … | + | |
77 … | +Or leave it empty and use the [link text itself] | |
78 … | + | |
79 … | +URLs and URLs in angle brackets will automatically get turned into links. | |
80 … | +http://www.example.com or <http://www.example.com> and sometimes | |
81 … | +example.com (but not on Github, for example). | |
82 … | + | |
83 … | +Some text to show that the reference links can follow later. | |
84 … | + | |
85 … | +[arbitrary case-insensitive reference text]: https://www.mozilla.org | |
86 … | +[1]: http://slashdot.org | |
87 … | +[link text itself]: http://www.reddit.com | |
88 … | + | |
89 … | +--- | |
90 … | +*Sources* | |
91 … | +This answer was taken almost verbatim from @nanomonkey's fantastic answer on Patchwork. |
faq/index.md | ||
---|---|---|
@@ -14,8 +14,9 @@ | ||
14 | 14 … | * [Applications](applications/applications.md) |
15 | 15 … | - [How do posts work across apps?](applications/patchwork-and-patchbay.md) |
16 | 16 … | - [Can I switch apps easily?](applications/moving-ssb-apps.md) |
17 | 17 … | - [Can I post from different devices?](applications/multiple-devices.md) |
18 … | + - [Is there a markdown guide for patchwork?](patchwork-markup.md) | |
18 | 19 … | * [Channels](channels/channels-index.md) |
19 | 20 … | - [What are channels?](channels/channels.md) |
20 | 21 … | - [Are Channels sorted in any order?](channels/channel-sort.md) |
21 | 22 … | - [How do channel descriptions work?](channels/channel-messages.md) |
Built with git-ssb-web