Hands up, who likes writing documentation? Yes, I know – it’s not everyone’s favorite task! It is, however, one of the most important tasks we need to perform when hosting a component library – in this chapter, I’ll take you through how we create the documentation for the Garnet library. We add a few badges to tell people information such as version numbers and licenses and work our way through writing the documentation for the Breadcrumbs component, as an example of how you can write the documentation for the remaining components in the library.

错误:搜索内容不能为空,请输入英文关键词
错误:关键词超出字数限制,请精简
高级检索

Writing Documentation

  • Alex Libby

摘要

Hands up, who likes writing documentation? Yes, I know – it’s not everyone’s favorite task! It is, however, one of the most important tasks we need to perform when hosting a component library – in this chapter, I’ll take you through how we create the documentation for the Garnet library. We add a few badges to tell people information such as version numbers and licenses and work our way through writing the documentation for the Breadcrumbs component, as an example of how you can write the documentation for the remaining components in the library.