Articles in this section

See more

README file format support and hierarchy in projects

Petter Olsson
  • Updated
Follow

Submitted originally by: petter.olsson

Domino will render multiple types of README file formats for a Domino project. If these files are present in the project, they will be rendered on the project overview. The ordered list of readme support is:

  1. README.md
  2. README.ipynb
  3. README.html
  4. README.htm
  5. README.txt
  6. README

This means that if a README.md file and a README.html file both exist, then Domino will render the README.md file first. Please note that the filenames are searched case-sensitive.   

 

Related articles

Comments

0 comments

Please sign in to leave a comment.