Basic Syntax / Images

Images

Images are most useful in docs when they show a UI state, a flow, or a diagram that text alone would make harder to follow.

Basic Syntax

![Alt text](image-url)

Write alt text that explains what the image contributes. “Homepage in dark mode” is far more useful than “image 1”.

Example

![Homepage in dark mode with the navigation visible](./images/home-dark-mode.png)

Image Links

If the image should open a source file, full-size asset, or repo page, wrap it in a standard link:

[![Deployment flow diagram](./images/deploy-flow.png)](https://github.com/Albert-Lsk/Markdown-Tutorial)

Best Practices

  • Prefer relative paths for repo assets so the document stays portable.
  • Crop screenshots so the focal point is obvious.
  • Use filenames that explain intent, such as home-dark-mode.png.
  • If an image needs too much explanation, add a short sentence before or after it instead of piling on more visuals.

Comments

Comments are currently unavailable.

Enable GitHub Discussions for this repository and complete the giscus configuration to turn comments on.