Session
Documentation for Developers
In this talk the speaker will explain and demonstrate the tools and platforms for writing and publishing technical documentation, such as developer's guides, technical books, API documentation and technical tutorials, along with his personal experience from the last 15 technical books published online using such tools.
Toolchains for building beautiful, flexible and searchable documentation like gitbook-cli, MkDocs and Sphinx will be discussed and demonstrated, along with platforms like Read The Docs (readthedocs.org) and GitBook (gitbook.com)
In a live demonstration, the speaker will show an example how to write an open-source technical book in GitHub, using Markdown articles, compiled into a single online book using the "gitbook-cli" static site generator and how to publish the book in GitHub Pages. A special attention will be given to more advanced techniques like embedding videos and live code examples (with [Run] button) in a smart way in Gitbook books.
This session is for beginners.
Please note that Sessionize is not responsible for the accuracy or validity of the data provided by speakers. If you suspect this profile to be fake or spam, please let us know.
Jump to top