GitHubWiki - jianwu13/PCTResearch GitHub Wiki
GitHub Wiki
- Basic syntax
- Quoting text
- Quoting code
- Links
- Relative links
- Lists
- Nested Lists
- Task lists
- Mentioning people and teams
- Supported color models
- Table
- Footnotes
- Task lists
- Images
Basic writing and formatting syntax
Basic writing and formatting syntax@GitHub wiki
Quoting text
You can quote text with a >.
Text that is not a quote
> Text that is a quote
Text that is not a quote
Text that is a quote
Quoting code
You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted.
Use `git status` to list all new or modified files that haven't yet been committed.
Use git status to list all new or modified files that haven't yet been committed.
To format code or text into its own distinct block, use triple backticks.
Some basic Git commands are:
\`\`\`
git status
git add
git commit
\`\`\`
Some basic Git commands are:
git status
git add
git commit
Links
This site was built using [GitHub Pages](https://pages.github.com/).
This site was built using GitHub Pages.
Relative links
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
Contribution guidelines for this project
Lists
You can make an unordered list by preceding one or more lines of text with -, *, or +.
- George Washington
* John Adams
+ Thomas Jefferson
- George Washington
- John Adams
- Thomas Jefferson
To order your list, precede each line with a number.
1. James Madison
1. James Monroe
1. John Quincy Adams
- James Madison
- James Monroe
- John Quincy Adams
Nested Lists
Type space characters in front of your nested list item until the list marker character (- or *) lies directly below the first character of the text in the item above it.
1. First list item
- First nested list item
- Second nested list item
- First list item
- First nested list item
- Second nested list item
- First nested list item
Task lists
To create a task list, preface list items with a hyphen and space followed by [ ]. To mark a task as complete, use [x].
- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:
- #739
- https://github.com/octo-org/octo-repo/issues/740
- Add delight to the experience when all tasks are complete :tada:
If a task list item description begins with a parenthesis, you'll need to escape it with \:
- [ ] \(Optional) Open a followup issue
- (Optional) Open a followup issue
Mentioning people and teams
You can mention a person or team on GitHub by typing @ plus their username or team name.
@github/support What do you think about these updates?
@github/support What do you think about these updates?
Supported color models
The background color is `#ffffff` for light mode and `#000000` for dark mode.
The background color is #ffffff for light mode and #000000 for dark mode.
Organizing information with tables
Cells can vary in width and do not need to be perfectly aligned within columns. There must be at least three hyphens in each column of the header row.
| Command | Description |
| --- | --- |
| git status | List all new or modified files |
| git diff | Show file differences that haven't been staged |
| Command | Description |
|---|---|
| git status | List all new or modified files |
| git diff | Show file differences that haven't been staged |
Formatting content within your table
You can use formatting such as links, inline code blocks, and text styling within your table:
| Command | Description |
| --- | --- |
| `git status` | List all *new or modified* files |
| `git diff` | Show file differences that **haven't been** staged |
| Command | Description |
|---|---|
git status |
List all new or modified files |
git diff |
Show file differences that haven't been staged |
You can align text to the left, right, or center of a column by including colons : to the left, right, or on both sides of the hyphens within the header row.
| Left-aligned | Center-aligned | Right-aligned |
| :--- | :---: | ---: |
| git status | git status | git status |
| git diff | git diff | git diff |
| Left-aligned | Center-aligned | Right-aligned |
|---|---|---|
| git status | git status | git status |
| git diff | git diff | git diff |
To include a pipe | as content within your cell, use a \ before the pipe:
| Name | Character |
| --- | --- |
| Backtick | ` |
| Pipe | \| |
To include a pipe | as content within your cell, use a \ before the pipe:
| Name | Character |
|---|---|
| Backtick | ` |
| Pipe | | |
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
[!NOTE] Highlights information that users should take into account, even when skimming.
[!IMPORTANT] Crucial information necessary for users to succeed.
[!WARNING] Critical content demanding immediate user attention due to potential risks.
Footnotes
Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
[^1]: My reference.
[^2]: To add line breaks within a footnote, prefix new lines with 2 spaces.
This is a second line.
Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
[^1]: My reference. [^2]: To add line breaks within a footnote, prefix new lines with 2 spaces. This is a second line.
Task lists
- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:
- #739
- https://github.com/octo-org/octo-repo/issues/740
- Add delight to the experience when all tasks are complete :tada:
Images
