Component & API Documentation
Create interactive component docs with Vue Styleguidist and beautiful API docs with apiDoc.
I. Introduction
| 1. Course introduction (01:31) |
II. API documentation with apiDoc
| 2. Module introduction & source code installation (01:37) | |
| 3. Setting up apiDoc (04:57) | |
| 4. Documenting the API (03:49) | |
| 5. Working with a request body (06:39) | |
| 6. Authenticated routes (05:15) | |
| 7. Reusing doc snippets (03:59) | |
| 8. API responses (08:08) | |
| 9. API docs finishing touches (05:01) |
III. Interactive component docs with Vue Styleguidist
| 10. Module introduction (00:39) | |
| 11. Creating a component styleguide (05:26) | |
| 12. Documenting components (06:40) | |
| 13. Creating live component previews (05:01) | |
| 14. Adding dependencies to preview components (04:32) | |
| 15. Passing props to preview components (04:07) | |
| 16. Adding Vuex to preview components (04:57) | |
| 17. Mocking Vue Router (04:37) | |
| 18. Mocking Vue Auth (05:10) | |
| 19. Styleguide finishing touches (03:12) |