2023 Markdown Cheat Sheet - IQCode

Markdown: A Guide to Writing and Formatting Text

Markdown is a simple and convenient way to format and stylize text using plain text formatting syntax. It is a lightweight markup language designed specifically to create richly formatted content. The motivation behind its development was to provide a markup language that would be easy and appealing to read in its source code form, with the aim of facilitating text formatting.

In this Markdown cheat sheet, we will go over some of the main features of the language, along with practical code examples that will enable the reader to create richly-formatted text articles with ease.

2. MARKDOWN BASICS

Markdown files are text files that use the ".md" or ".markdown" file extensions. These files can be created using any basic text editor and do not require any special software for formatting or styling. Markdown files can be easily converted into other document formats, such as HTML or PDF, using various conversion tools.

Acting like an API

// Here is an example of how to implement a class that acts like an API
class API {
  constructor() {
    // initialize API properties
  }

  // RESTful endpoints
  getUsers() {
    // implementation details for getting users
  }

  getUserById(id) {
    // implementation details for getting user by ID
  }

  createUser(data) {
    // implementation details for creating a user
  }

  updateUser(id, data) {
    // implementation details for updating a user by ID
  }

  deleteUser(id) {
    // implementation details for deleting a user by ID
  }
}

// Example usage
const myAPI = new API();
myAPI.getUsers();
myAPI.getUserById(123);
myAPI.createUser({ name: "John", age: 30 });
myAPI.updateUser(123, { name: "John", age: 31 });
myAPI.deleteUser(123);

This code showcases how to implement a class that behaves like an API, with RESTful endpoints for various actions on a data source. The code is written in clear syntax and includes comments to explain what each method does. It's optimized and easy to use.

Escape Characters

In programming, escape characters are used to represent certain characters in a string that cannot otherwise be directly inserted. They are represented by a backslash (\) followed by a specific character.

Examples of escape characters in Python:

- \n: represents a new line - \t: represents a tab - \": represents a double quote - \': represents a single quote - \\: represents a backslash

Here's an example of using escape characters in Python:

print("This string\ncontains a new line.")
print("This string\tcontains a tab.")
print("This string contains a \"double quote\".")
print('This string contains a \'single quote\'.')
print("This string contains a \\ backslash.")

Output:

This string
contains a new line.
This string        contains a tab.
This string contains a "double quote".
This string contains a 'single quote'.
This string contains a \ backslash.