README support

Domino will render multiple types of README file formats for each Domino Project. If these files are present in the project, they will be rendered on the project overview tab. 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 (just as an example), then Domino will render the README.md file first. 

Please note that the filenames are searched case-sensitive. 

For any existing projects, you will not see any change or need to take any action.

Here's an example of a Jupyter Notebook rendering on a Domino Project 'overview' page:

 

Was this article helpful?
0 out of 0 found this helpful