As we noted back in August and October last year, Gui Talarico created an extremely useful online version of the contents of the Revit API help file RevitAPI.chm.
It sports several significant advantages over the locally hosted Windows help file:
- Online access from anywhere, any platform, OS, device.
- Share links to specific topics for discussion with peers.
- Covers and compares between multiple versions of the Revit API.
During the expansion to integrate the new information to cover Revit 2017.1, Gui implemented a number of other significant enhancements as well:
- Revit 2017.1 API added.
- New parsers written from the ground up. This creates cleaner and more consistent html mark-ups from the original CHM content.
- Content is compared across yearly versions, and when identical, only one copy is being stored and served (storing only 25k html files vs +80k, previously).
- Smarter nav-bar now also indicates if the doc was updated/removed across years, for example the WallFoundation class – note the coloured bars and tooltips under the year numbers.
- Result filtering: search result page now has a text box user can use to further filter results; try it out.
- Python Examples – adds Python snippets if one is found (beta).
- Ajax loading: when possible, content is loaded asynchronously, for a more seamless navigation.
- Language switcher: allows user to only see code from the selected language.
- Copy code – code examples now have a
Copy
button which copies to the clipboard. - Implemented Handlebars JS templating engine for more maintainable front-end code.
- All API documentation pages are now fully editable; just click
Edit
in the upper-right corner, to edit and send a pull request. - Many other bug fixes and improvements behind the scenes.
These updates are currently available for testing at beta.revitapidocs.com and will be pushed to the main server once they have been battle tested.
Please report any issues or bugs on the 2.0 milestone.
Thank you for participating, and many thanks to Gui for creating and maintaining this wonderful tool for the entire community!
For more information, please refer to Gui's own full description of Revit API Docs 2.0.