@idux/archive

@idux/archive is a documentation builder for components library and any need to create interactive documentation site.

more infomation on idux archvie site

<div align="center"> <!-- [](https://dev.azure.com/iduxfeteam/IduxFE/_build/latest?definitionId=2&branchName=main) [](https://codecov.io/gh/IDuxFE/idux) -->

<!-- [](https://www.codefactor.io/repository/github/iduxfe/idux) -->

<!-- [](https://github.com/IDuxFE/idux/contributors) -->

</div>

English | 简体中文

✨ Features

• Based on Idux Design and components
• Written in TypeScript with complete defined types
• Monorepo: archive, archive-app, archive-collector-collector...
• Create interactive documentation site for your project
• Document demos of vue and other
• Highly extensiable
• Deeply customizable
• Powerful theme customization

<!-- - Internationalization support for various languages -->

📦 Installation

npm install --save @idux/archive

⌨️ Development

pnpm install

Enter any example then run

npm run dev

🤝 Contributing

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as Pull Request or as GitHub issues.

💖 Thanks

Many of the features are inspired by the following awesome projects.

• Histoire
• VitePress

🚩 Roadmap

• Add component API doc auto generation support
• Better HMR support
• Better log support
• Add plugin system to encapsulate customizations
• Add controls to modify demo data or paramaters on web UI
• Add doc meta data extraction and searching support
• Typescript format configuration
• Add homepage support

☀️ License

MIT © 2022-present IDuxFE