compodoc - :notebook_with_decorative_cover: The missing documentation tool for your Angular application

  •        28

The missing documentation tool for your Angular application. The demo features documentation generated for a simple TodoMVC application.


@compodoc/ngd-transformer : ^2.0.0
chalk : ^2.4.1
cheerio : ^1.0.0-rc.2
chokidar : ^2.0.4
colors : ^1.3.2
commander : 2.19.0
cosmiconfig : ^5.0.6
fancy-log : ^1.3.2
findit2 : ^2.2.3
fs-extra : ^7.0.0
glob : ^7.1.3
handlebars : 4.0.10
html-entities : ^1.2.1
i18next : ^11.9.1
inside : ^1.0.0
json5 : ^2.1.0
live-server : 1.2.0
lodash : ^4.17.11
lunr : 2.3.3
marked : ^0.4.0
opencollective : ^1.0.3
os-name : ^2.0.1
traverse : ^0.6.6
ts-simple-ast : 12.4.0
uuid : ^3.3.2



Related Projects

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

Dox is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply gives you a JSON representation, allowing you to use markdown and JSDoc-style tags.This output can then be passed to a template for rendering. Look below at the "Properties" section for details.

clarity - UX guidelines, HTML/CSS framework, and Angular components working together to craft exceptional experiences

  •    TypeScript

Project Clarity is an open source design system that brings together UX guidelines, an HTML/CSS framework, and Angular components. This repository includes everything you need to build, customize, test, and deploy Clarity. For complete documentation, visit the Clarity website.The easiest way to run a sample Angular application with Clarity is to use the Clarity Seed.

vue-styleguidist - Created from react styleguidist for Vue Components with a living style guide

  •    Javascript

Project was started when not finding a tool that generates documentation of components with hot reloading, read documentation and have a playground. Created from React Styleguidist, implement additional support to read and compile .vue files. Only supports 2.x. Vue Styleguidist is a style guide generator for Vue components. It lists component and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server.

storybook - UI component dev & test: React, Vue, Angular, React Native, Ember, Web Components & more!

  •    TypeScript

Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively develop and test components. Storybook runs outside of your app. This allows you to develop UI components in isolation, which can improve component reuse, testability, and development speed. You can build quickly without having to worry about application-specific dependencies.

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

JavaScript documentation generator for node using markdown and jsdoc

ngx-admin - Admin dashboard template based on Nebular framework (Angular 4+, Bootstrap 4) previously known as ng2-admin

  •    TypeScript

We will continue supporting ng2-admin version, but if you are starting from scratch we recommend using ngx-admin version. Unfortunately, there is no way to update from ng2-admin to ngx-admin, but some parts (Nebular components) could be manually included.This template is based on Nebular framework, documentation and other useful articles could be found here.

ngd - View the dependencies tree of you Angular application

  •    TypeScript

A tool that allows you to view your Angular application dependencies. Note: This will read the files entry point in your tsconfig.json and crawl your app. If the entry point is not found, all *.ts files will be crawled, but not those mentioned in the exclude property (more details).

typedoc - Documentation generator for TypeScript projects.

  •    HTML

Documentation generator for TypeScript projects. Like the TypeScript compiler, TypeDoc comes with a binary that can be called from anywhere if you install TypeDoc as a global module. The name of the executable is typedoc.

Augury - Angular Debugging and Visualization Tools

  •    Typescript

Augury is the most used Google Chrome Developer Tool extension for debugging and profiling Angular 2 applications. It helps Angular 2.0 developers visualize the application through component trees, and visual debugging tools. Developers get immediate insight into their application structure, change detection and performance characteristics.

documentation.js - Documentation for modern JavaScript

  •    Javascript

documentation.js is a documentation tool for mordern JavaScript. It Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations. It provides customizable output: HTML, JSON, Markdown, and more.

tsdoc - A doc comment standard for the TypeScript language

  •    TypeScript

We are developing a library package @microsoft/tsdoc that provides an open source reference implementation of a parser. Using this library is an easy way to ensure that your tool is 100% compatible with the standard. These are just examples. Many other tools in today's web developer community want to interact with TypeScript doc comments. Each of these tools accepts a syntax that is loosely based on JSDoc, but encounters frustrating incompatibilities when attempting to coexist with other parsers.

ngx-pipes - ⚡️ Useful pipes for Angular with no external dependencies!

  •    TypeScript

TypeSerializer - Another library you might find interesting. Serializer / Deserializer, designed to make prettier code while using decorators (Can be used both with Angular or Node.js).

cppast - Library to parse and work with the C++ AST

  •    C++

Library interface to the C++ AST — parse source files, synthesize entities, get documentation comments and generate code. If you're writing a tool that needs access to the C++ AST (i.e. documentation generator, reflection library, …), your only option apart from writing your own parser is to use clang. It offers three interfaces for tools, but the only one that really works for standalone applications is libclang. However, libclang has various limitations and does not expose the entire AST.

ESDoc - Good Documentation for JavaScript

  •    Javascript

ESDoc is a documentation generator for JavaScript. It generates good documentation. It can measure documentation coverage, Integrate test codes into documentation, Parse ECMAScript proposals.

angular-starter - :tada: An Angular Starter kit featuring Angular (Router, Http, Forms, Services, Tests, E2E, Dev/Prod, HMR, Async/Lazy Routes, AoT via ngc), Karma, Protractor, Jasmine, Istanbul, TypeScript, TsLint, Codelyzer, Hot Module Replacement, @types, and Webpack by @TipeIO

  •    Javascript

An Angular starter kit featuring Angular 5, Ahead of Time Compile, Router, Forms, Http, Services, Tests, E2E), Karma, Protractor, Jasmine, Istanbul, TypeScript, @types, TsLint, Codelyzer, Hot Module Replacement, and Webpack by AngularClass.This seed repo serves as an Angular starter for anyone looking to get up and running with Angular and TypeScript fast. Using a Webpack 3 for building our files and assisting with boilerplate. We're also using Protractor for our end-to-end story and Karma for our unit tests.