Frequently asked questions
Show your books on your profile
The Library tab of a public profile lists the books you write in a file of the project's repository. You add the file with a pull request, and the profile reads it from there.
- Keep your profile public (it is by default) and sign in with the GitHub account that will name the file.
- Fork the project repository on GitHub.
- In your fork, create this file, using your GitHub login in lowercase:
public/books/your-login.md - Fill it with one block of lines per book, like the example below.
- Open a pull request. A check confirms that the author of the pull request owns the file.
- After the merge, your books show up on your Library tab within about 15 minutes.
---
title: Designing Data-Intensive Applications
url: https://dataintensive.net/
pages: 616
cover: https://covers.openlibrary.org/b/isbn/9781449373320-L.jpg
comment: Explains why data systems work the way they do.
comment: The chapters on replication and consistency are worth a second read.
---
---
title: Clean Code
url: https://www.oreilly.com/library/view/clean-code-a/9780136083238/
pages: 464
---The rules
- title, url and pages are required. cover and comment are optional.
- Put each book between two --- lines, like the metadata at the top of a concept. A blank line also ends a book.
- pages is the total number of pages, from 1 to 5000. It sets how thick the book is on the shelf.
- cover is the address of the cover image. Without it the book shows its title on a plain cover.
- comment is plain text shown with the title when the book is opened. Each comment line is a paragraph, up to 4 lines of 500 characters. Links and formatting are shown as typed, never interpreted.
- url and cover must start with https://. A book that breaks a rule is ignored; the other books still show.
- Up to 200 books per file.
Prefer a table?
A table works too, one row per book: the title as a link, the pages and the cover (it can be empty). It has no comment column, and a title cannot contain the | character. You can mix tables and blocks in the same file.
| Book | Pages | Cover |
| --- | --- | --- |
| [Designing Data-Intensive Applications](https://dataintensive.net/) | 616 | https://covers.openlibrary.org/b/isbn/9781449373320-L.jpg |
| [Clean Code](https://www.oreilly.com/library/view/clean-code-a/9780136083238/) | 464 | |The file is public and carries your GitHub login, so anyone can tie the books on your profile to your GitHub account.