Forum Code Formatting and Syntax Highlighting

To format code in this forum you need to surround the code with three backticks (```). For example, typing this...

```
fn main() {
    println!()
}
```

...will be rendered as highlighted Rust code, like so:

fn main() {
    println!()
}

You can also tell the forum software which language you're using by adding the language after the opening backticks.

```cpp
#include <iostream>
int main() {
  std::cout << "Hello World!";
}
```

Will appear with highlighting as:

#include <iostream>
int main() {
  std::cout << "Hello World!";
}

The currently supported languages include: apache, bash, cs, cpp, css, coffeescript, diff, xml, http, ini, json, java, javascript, makefile, markdown, nginx, objectivec, ruby, perl, php, python, sql, handlebars, rust and dust. Others may be added in the future.

It's also possible to add plain text by using text as the language:

```text
Error 365: Invalid command.
See help for a list of valid commands.
```

This will be rendered without any highlighting:

Error 365: Invalid command.
See help for a list of valid commands.

If your keyboard layout does not have the ` key, you can also use a ~.

~~~
fn main() {
    println!()
}
~~~

...will be rendered as highlighted Rust code, like so:

fn main() {
    println!()
}
20 Likes
Remove an element from the vector
Error in Format!
Help with multithreading - x/y axis manipulation
How to print value of a pointer
How to parse reqwest::blocking::response json to a struct
Parse multiple input based on jsonfile with lettre
Problem with lifetimes in Rc<RefCell<T>>
Help about RefCell
Help with read-write data from TCP server-to server (also converting)
Abstracting serialization of specific state types
Help with Mutex on fst
Lifetime issue with deserialization
Passing channels to threads
Calling for method "poll_next()" on a ClientSStreamReceiver gives error: "method not found"
Immutable borrow when using .get on hashmap
Python to Rust Code converter
Why "move occurs"
Newbie: Why the commented line stops the snippet from compiling?
If program leave loop, does program loses ownership of the variable?
Why can't I use the value in the vector for comparative operation?
Problem sharing futures across threads when call from warp filter
Deserialize JSON array of structs without element types using serde
Guessing_Game Compile Issue
C Variadic functions in rust macro showing error
Assert_eq in a for loop
Problem with installing(windows)
How to build C static library into a rust crate for no_std environmrnt
Rust Postgres Interval DataType Insert Problem
Cannot infer type for type parameter `S` declared on the function
How to print two user input in a single line?
Pass function closure to thread
C++ converted to Rust, compiled ok but got a bad result. Which step is wrong?
C++ converted to Rust, compiled ok but got a bad result. Which step is wrong?
Lifetime params for more complex function returns
Store a reference
I'm new and i need help with code
Diesel Problem when loading
Input shows enter ./n
Unable to read or update hashMap values
Why am I not allowed to copy part of a list filled with i32 to another variable?
How to get hashmap key values
Unmatched pointer value of a string when ownership is passed on
Use statements inside functions
Taking input from scv file
Help: Cloning string in the getter
Issue related to use of break statement with Ok variant
Confused on errors while going through option1.rs rustling
In a struct why must I use &str and a lifetime
`std::convert::From<mime::Mime>` is implemented for `&mut str`, but not for `&str`
[Solved] Escape Quotes and Back Slash in Process Command Arguments
Cannot use `self....` because it was mutably borrowed
Confusion as a new rustacean
How to compare variables of two types without type conversion or type casting using if statement
Snmp recoverable error handling
Zero initialize a large complex struct as global without code overhead
Parse two errors in async function with reqwest
Pinned topics and categories
Temporary Value Dropped While Borrowed Using into_iter
Problem with OpenOptions and write_all()
How to read a connection for a serial?
Postgresql performance
What does the word "s" mean?
1) convenient passing arguments to println!; 2) difference between slice and &str
Hyper example proxy with rustls
Here i have skipped 7 line but now i want to get result from that result which i have skipped. I want to get 1st line from it but i can not get it then how can i get this first line?
Rust-qt project compiling issue
How to collect string of input into array?
Practicing match and enum functions

Seems like pinning this thread would be fine?

6 Likes

This is part of "markdown", a standard text formatting syntax not unique to Github. These days most implementations I know of are using the CommonMark spec with some extentions. Here are some links:

I've also personally used ```s and other bits of markdown on StackOverflow, Slack and Discord, so it's pretty close to universal.

5 Likes

Since this has now been pinned (thanks!) I've removed the last note that lxrec is responding to, but I'll copy it here for posterity:

Summary

However this way of posting code isn't so obvious. It relies on a new user being aware of the github syntax and guessing that this forum uses the same syntax. I didn't when I first arrived and frequently new users post code that's hard to read because they aren't aware of how to format it for this forum's software.

Could there be somewhere that explains this placed where new users can see it?

I didn't realize that the syntax was now in the CommonMark spec. Thanks for the correction.

2 Likes