README and images
The repository's preferred README becomes the detail-page description. It can sit in the repository root, docs/ or .github/ and can be up to 512 KB. Write it on GitHub; you do not need to maintain another description on the website.
Headings, paragraphs, lists, tables, code blocks, blockquotes, links and repository images are supported. HTML is sanitized before display. Scripts, embedded frames, custom styles and event handlers are removed.
Repository images#
Keep images in the repository and reference them with relative paths in Markdown or in an HTML img tag:
## Library
Manifest image paths are relative to the repository root. README image paths are relative to the README's own directory. For example, a README inside docs/ can use ../assets/library.png.
Supported image types are PNG, JPEG, GIF and WebP. Each image must be at most 5 MB, at most 10,000 pixels on either side and at most 40 megapixels. An import supports up to 24 images and 25 MB of image data in total.
Images from external websites appear as links. Repository images are stored with the imported revision so the preview and approved page show the same content.
Links and revisions#
Relative file links point to the imported commit on GitHub. Heading links within the README work on the catalog page. Regular HTTPS links remain links to their original destinations.
After the first approval, changed README text and images are imported through update synchronization. The public page changes only when a valid replacement revision is published.