Dope Docs
:lipstick: :green_book: Storybook inspired UI docs generation for your Angular projects
Overview
Dope Docs is an innovative CLI and library designed to help developers generate stunning documentation, style guides, and demos specifically tailored for Angular UI components, directives, and pipes. Aimed at enhancing the development process, it serves as a powerful tool that streamlines the documentation flow for Angular applications, allowing teams to create polished component libraries effortlessly.
Whether you are bootstrapping a new project or enhancing an existing one, Dope Docs makes it easy to document each UI element by following a simple naming convention. With this library, developers can stop procrastinating and focus on what truly matters—building exceptional user experiences.
Features
- Angular Support: Built exclusively for Angular 2 and beyond, ensuring compatibility with modern frameworks for seamless integration.
- Easy Installation: Get started quickly by using simple commands like
yarn add @angularclass/dope-docs. - Documentation Generation: Automatically create documentation for every UI element by following the straightforward naming convention of
[name].doc.ts. - Example Handling: Enhance your documentation with multiple examples for different states of your UI components, making it easy to demonstrate functionality.
- Bootstrapping Capability: As an Angular app, Dope Docs can be bootstrapped with your examples, simplifying setup for testing and previews.
- Custom Build Setup: Simply create a
dope.jsfile at your project root, allowing Dope Docs to adapt to your specific build configurations seamlessly. - Inspired Design: Features borrowed and improved from popular tools like Component Lab and React Storybook to provide a familiar yet enhanced user experience.
- Community Contributions: Open to PRs and issues, inviting collaboration and enhancement from the developer community to continue evolving the tool.
- Angular
Angular is a TypeScript-based open-source framework by Google for building dynamic single-page applications and cross-platform mobile apps with MVC architecture and a rich set of features.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Prism JS
PrismJS is an open-source, lightweight, and extensible syntax highlighting library that supports a wide range of programming languages and markup formats.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
- Webpack
Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.