An open API service indexing awesome lists of open source software.

https://github.com/compodoc/compodoc-demo-todomvc-angular-standalone

Angular demo application of TodoMVC documented, in standalone mode, and ready for compodoc
https://github.com/compodoc/compodoc-demo-todomvc-angular-standalone

Last synced: 6 days ago
JSON representation

Angular demo application of TodoMVC documented, in standalone mode, and ready for compodoc

Awesome Lists containing this project

README

          

# Compodoc Demo TodoMVC Angular

This project was generated with [angular-cli](https://github.com/angular/angular-cli).

It is a demo project for demonstrating Compodoc features :

- architecture
- components documentation
- embedding images
- documentating methods and properties of components, classes, interfaces, etc...

## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive/pipe/service/class/module`.

## Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.

## Further help

To get more help on the `angular-cli` use `ng --help` or go check out the [Angular-CLI README](https://github.com/angular/angular-cli/blob/master/README.md).

## Compodoc supports syntax highlighting

```javascript
function hello() {
console.log("hello world !");
}
```

## Screenshots of the application - (for assets embedding demo)

| Home page | About page |
| ------------------------------------- | -------------------------------------- |
| ![Screenshot-1](screenshots/home.png) | ![Screenshot-2](screenshots/about.png) |