From ad0e26dc04008feec8de0603c88fbd63f87c18ec Mon Sep 17 00:00:00 2001 From: Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com> Date: Mon, 26 Jul 2021 20:25:54 +0200 Subject: Markdown Statuses (#116) * parse markdown statuses if desired * add some preliminary docs for writing posts --- docs/user_guide/writing_posts.md | 48 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/user_guide/writing_posts.md (limited to 'docs/user_guide/writing_posts.md') diff --git a/docs/user_guide/writing_posts.md b/docs/user_guide/writing_posts.md new file mode 100644 index 000000000..7318242f5 --- /dev/null +++ b/docs/user_guide/writing_posts.md @@ -0,0 +1,48 @@ +# Writing Posts + +TODO + +## Formatting + +This section describes the different post input types accepted by GoToSocial, and the method GtS uses to parse text into HTML. + +### Links + +Any recognized links in the text will be shortened and turned into proper hyperlinks. For example: + +> Here's a link to something: https://example.org/some/link/address + +will become: + +> Here's a link to something: [example.org/some/link/address](https://example.org/some/link/address) + +### Mentions + +You can 'mention' another account by referring to the account in the following way: + +> @some_account@example.org + +In this example, `some_account` is the username of the account you want to mention, and `example.org` is the domain that hosts their account. + +The mentioned account will get a notification that you've mentioned them, and be able to see the post in which they were mentioned. + +Mentions are formatted in a similar way to links, so: + +> @some_account@example.org + +will become: + +> @some_account + +## Input Types + +GoToSocial currently accepts two different types of input. These are: + +* `plain` +* `markdown` + +Plain is the default method of posting: GtS accepts some plain looking text, and converts it into some nice HTML by parsing links and mentions etc. + +Markdown is a more complex way of organizing text, which gives you more control over how your text is parsed and formatted. + +For more information on markdown, see [The Markdown Guide](https://www.markdownguide.org/). -- cgit v1.2.3