Add ASCII art to a GitHub README
Put your drawing in a fenced code block in the README. It stays part of the Markdown source and can be edited with the rest of the document.
# Build status
```
+---------+
| READY |
+---------+
```Three steps
- Open README.md in a plain text editor and paste a heading or a brief caption.
- Put the art on its own lines between two fences of three backticks.
- Preview the rendered Markdown and check how the block appears in a narrow browser window.
Keep the source easy to edit
Use spaces instead of tabs inside the block and leave out a language label if you want plain text. Store the entire drawing in a TXT file when you reuse it in multiple documents, and keep copies short enough to scan in the Markdown source.
Keep the information in regular prose
For a banner containing a project name, include the actual project name in a Markdown heading as well. The character image can decorate the page while the heading remains ordinary searchable text.
Choose the display format deliberately
A code block keeps the characters copyable. An image can be better for a detailed logo that takes more space than you want to use in the README. Give an image meaningful alternative text and keep the TXT source for editing.
Questions
What should I check in the Markdown preview?
Check the start and end of the code block, the alignment of the lines and whether the block takes too much horizontal space.