Page 1 of 1
Migration Away from MicroPython.org to GitHub?
Posted: Tue Aug 30, 2022 1:47 pm
by MMliam
Why is there an apparent migration of discussions away from the MicroPython.org site to GitHub. MicroPython.org has superior tools, particularly when is comes to inserting code snippets:
Code: Select all
For clarity,
this format is
far superior
to anything
offered on GitHub
Re: Migration Away from MicroPython.org to GitHub?
Posted: Tue Aug 30, 2022 2:07 pm
by scruss
There's an existing thread here:
Migration to GitHub Discussions
Github's ``` (triple backtick) notation for included code is okay once you get used to it.
Re: Migration Away from MicroPython.org to GitHub?
Posted: Tue Aug 30, 2022 2:21 pm
by MMliam
I had tried the "triple backtick" before posting my question.
The problem I saw, was it merged all instructions on a single line with only a space in between. Then, when I added a CRLF it put an empty line between each instruction. Is that normal?
For example after inserting CR-LF's:
https://github.com/orgs/micropython/discussions/9128
Re: Migration Away from MicroPython.org to GitHub?
Posted: Tue Aug 30, 2022 2:23 pm
by jimmo
MMliam wrote: ↑Tue Aug 30, 2022 2:21 pm
I had tried the "triple backtick" before posting my question.
The problem I saw, was it merged all instructions on a single line with only a space in between. Then, when I added a CRLF it put an empty line between each instruction. Is that normal?
For example:
https://github.com/orgs/micropython/discussions/9128
It looks like you only used a single backtick
`foo
bar`
you need to use triple backtick for a code block
```
foo
bar
```
See
https://docs.github.com/en/get-started/ ... oting-code
Re: Migration Away from MicroPython.org to GitHub?
Posted: Tue Aug 30, 2022 2:28 pm
by jimmo
In GitHub, you can also select your code and click the <> button in the editing toolbar (like you can on phpbb) to automatically do the right thing. If it's a inline selection it will use single-backtick, if it's multi-line selection it will triple-backtick.
MMliam wrote: ↑Tue Aug 30, 2022 1:47 pm
MicroPython.org has superior tools, particularly when is comes to inserting code snippets:
In my opinion GitHub's formatting tools are vastly superior -- not only does it support inline snippets, but it also supports syntax highlighting. It's also Markdown which is becoming the de-facto standard everywhere.
Re: Migration Away from MicroPython.org to GitHub?
Posted: Tue Aug 30, 2022 2:31 pm
by MMliam
I created this "Test Discussion" to demonstrate.
https://github.com/micropython/micropyt ... sions/9154
The original source had a CR-LF between each line, but they are ignored in the standard format.
Re: Migration Away from MicroPython.org to GitHub?
Posted: Tue Aug 30, 2022 4:39 pm
by DeaD_EyE
The original source had a CR-LF between each line, but they are ignored in the standard format.
This is normal. Many Forums are doing this + indentation is also lost.
Put Code into Code-Tags:
You should read this:
https://docs.github.com/en/get-started/ ... ing-syntax
Re: Migration Away from MicroPython.org to GitHub?
Posted: Thu May 25, 2023 8:20 am
by Jackli
GitHub discussions have more features for posts and replies. Emoticon replies, accepted answers, thread replies, etc.
GitHub discusses using more familiar Markdown syntax to write posts, especially code snippets (which also support syntax highlighting).