# Generating docs for own components like ionic-docs

**URL:** <https://forum.ionicframework.com/t/generating-docs-for-own-components-like-ionic-docs/139135>\
**Category:** Ionic Framework\
**Created:** [August 21, 2018, 11:13am UTC](https://forum.ionicframework.com/t/generating-docs-for-own-components-like-ionic-docs/139135 "2018-08-21T11:13:43Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![Kerosin](https://sea1.discourse-cdn.com/ionicframework/user_avatar/forum.ionicframework.com/kerosin/32/104313_2.png) [@Kerosin](https://forum.ionicframework.com/u/Kerosin)\
**Post date:** [August 21, 2018, 11:13am UTC](https://forum.ionicframework.com/t/generating-docs-for-own-components-like-ionic-docs/139135/1 "2018-08-21T11:13:43Z")

</div>

Hey there,

is it possible to generate a documentation like the [API Reference](https://beta.ionicframework.com/docs/api/) from the [ionic-docs](https://github.com/ionic-team/ionic-docs) for my own components?

I know there are several other tools to generate documentation like [TypeDoc](http://typedoc.org/), [Compodoc](https://github.com/compodoc/compodoc) or [StoryBook](https://github.com/storybooks/storybook), but I really like the way the components are documented and previewed!

The preview in a mobile frame with the option to switch the OS is definitely a unique feature. Would be great to stick to the Ionic universe for generating docs.

Could the toolchain/scripts from ionic-docs be used to generate own content? Has anyone experience in doing so?

Thanks in advance 🙂

---

<div class="post-metadata">

**Author:** ![guibertol](https://avatars.discourse-cdn.com/v4/letter/g/eb9ed0/32.png) [@guibertol](https://forum.ionicframework.com/u/guibertol)\
**Post date:** [August 21, 2018, 8:55pm UTC](https://forum.ionicframework.com/t/generating-docs-for-own-components-like-ionic-docs/139135/2 "2018-08-21T20:55:53Z")

</div>

eu acredito que essa seria a melhor maneira. porem uma ideia que tive é você gravar a interação com os componentes em forma de gif, não é a melhor solução, mas é uma solução simples.

---

<div class="post-metadata">

**Author:** ![reedrichards](https://avatars.discourse-cdn.com/v4/letter/r/34f0e0/32.png) [@reedrichards](https://forum.ionicframework.com/u/reedrichards)\
**Post date:** [August 22, 2018, 8:47pm UTC](https://forum.ionicframework.com/t/generating-docs-for-own-components-like-ionic-docs/139135/3 "2018-08-22T20:47:45Z")

</div>

Just an idea, I don’t know any tools, but maybe you could clone the doc project of Ionic and then use it for your doc if you want the exact same setup?

> **[ionic-team/ionic-docs](https://github.com/ionic-team/ionic-docs)**
>
> ionic-docs - Docs for the Ionic Framework

Like I said just an idea…

---

<div class="post-metadata">

**Author:** ![mhartington](https://sea1.discourse-cdn.com/ionicframework/user_avatar/forum.ionicframework.com/mhartington/32/137757_2.png) [@mhartington](https://forum.ionicframework.com/u/mhartington)\
**Post date:** [July 19, 2021, 9:22pm UTC](https://forum.ionicframework.com/t/generating-docs-for-own-components-like-ionic-docs/139135/4 "2021-07-19T21:22:56Z")

</div>