Skip to content

Project  #33644

@Xf9s

Description

@Xf9s

Code of Conduct

What article on docs.github.com is affected?

Here’s a guide to creating sophisticated formatting for your prose and code on GitHub using basic syntax:

Basic Writing and Formatting Syntax on GitHub

GitHub uses Markdown syntax to format text. Here are some key elements you can use:

Headers

# Header 1
## Header 2
### Header 3

Emphasis

*Italic* or _Italic_
**Bold** or __Bold__
~~Strikethrough~~

Lists

Unordered List:

- Item 1
- Item 2
  - Subitem 1
  - Subitem 2

Ordered List:

1. Item 1
2. Item 2
   1. Subitem 1
   2. Subitem 2

Links

[Link Text](URL)

For example:

[GitHub Guide](https://guides.github.com/features/mastering-markdown/)

Images

![Alt Text](URL)

Code

Inline Code:

`code`

Code Block:

code block

Blockquotes

> This is a blockquote.

Task Lists

- [x] Task 1
- [ ] Task 2

Example

Here’s an example combining several elements:

# My Project

Welcome to my project! This project is **awesome**.

## Features

- Feature 1
- Feature 2
  - Subfeature 1
  - Subfeature 2

## Usage

To use this project, follow these steps:

1. Clone the repository.
2. Install dependencies.
3. Run the application.

## Code Example

Here is a sample code snippet:

def hello_world():
print("Hello, world!")


## Links

For more information, visit the [GitHub Guide](https://guides.github.com/features/mastering-markdown/).

## Tasks

- [x] Complete the setup
- [ ] Add more features

You can find more detailed information in the GitHub Docs.

I hope this helps you create well-formatted content on GitHub!

What part(s) of the article would you like to see updated?

Sure! Here’s a guide to creating sophisticated formatting for your prose and code on GitHub using basic syntax:

Basic Writing and Formatting Syntax on GitHub

GitHub uses Markdown syntax to format text. Here are some key elements you can use:

Headers

# Header 1
## Header 2
### Header 3

Emphasis

*Italic* or _Italic_
**Bold** or __Bold__
~~Strikethrough~~

Lists

Unordered List:

- Item 1
- Item 2
  - Subitem 1
  - Subitem 2

Ordered List:

1. Item 1
2. Item 2
   1. Subitem 1
   2. Subitem 2

Links

[Link Text](URL)

For example:

[GitHub Guide](https://guides.github.com/features/mastering-markdown/)

Images

![Alt Text](URL)

Code

Inline Code:

`code`

Code Block:

code block

Blockquotes

> This is a blockquote.

Task Lists

- [x] Task 1
- [ ] Task 2

Example

Here’s an example combining several elements:

# My Project

Welcome to my project! This project is **awesome**.

## Features

- Feature 1
- Feature 2
  - Subfeature 1
  - Subfeature 2

## Usage

To use this project, follow these steps:

1. Clone the repository.
2. Install dependencies.
3. Run the application.

## Code Example

Here is a sample code snippet:

def hello_world():
print("Hello, world!")


## Links

For more information, visit the [GitHub Guide](https://guides.github.com/features/mastering-markdown/).

## Tasks

- [x] Complete the setup
- [ ] Add more features

You can find more detailed information in the GitHub Docs.

I hope this helps you create well-formatted content on GitHub! @topfunky @bruce

Additional information

Project

Metadata

Metadata

Assignees

No one assigned

    Labels

    invalidThis issue/PR is invalid

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions