Giter Club home page Giter Club logo

ngdoc-template's Introduction

Docgeni Template

A template for Angular Lib & Docs use Docgeni.

docgeni

How to use?

Click the top right button "Use this template" of this repo.

Use Docgeni Template

Live Preview

https://docgeni.github.io/docgeni-template

Commands

  • npm run start: start development for this lib, it is an alias for npm run start:docs
  • npm run build: build this angular component lib
  • npm run test: exec unit tests of component lib
  • npm run build:docs: build docs site to dist/docgeni-site
  • npm run lint: lint component lib

Directory Structure

.
|── .docgeni
│   ├── public
│   │   ├──assets
│           ├── images
│   │   ├──tsconfig.json
├── docs
│   ├── guides
│   │   ├── getting-started.md
│   │   ├── index.md
│   │   └── intro.md
│   └── zh-cn
│       └── guides
│           ├── getting-started.md
│           ├── index.md
│           └── intro.md
├── src
│   ├── README.md
│   ├── button
│   │   ├── api
│   │   │   ├── en-us.js
│   │   │   └── zh-cn.js
│   │   ├── button.component.html
│   │   ├── button.component.spec.ts
│   │   ├── button.component.ts
│   │   ├── button.module.ts
│   │   ├── doc
│   │   │   ├── en-us.md
│   │   │   └── zh-cn.md
│   │   ├── examples
│   │   │   ├── basic
│   │   │   │   ├── basic.component.css
│   │   │   │   ├── basic.component.html
│   │   │   │   └── basic.component.ts
│   │   ├── index.ts
│   │   └── package.json
│   ├── karma.conf.js
│   ├── ng-package.json
│   ├── package.json
│   ├── public-api.ts
│   ├── test.ts
│   ├── tsconfig.lib.json
│   ├── tsconfig.lib.prod.json
│   ├── tsconfig.spec.json
│   └── tslint.json
├── angular.json
├── tsconfig.json
├── tslint.json
├── package-lock.json
├── package.json
└── README.md

Angular Versions

Current Angular Version: 15.x

Angular Branch
11.x ng-11.x
12.x master
13.x master
14.x master
15.x master

ngdoc-template's People

Contributors

2909365394 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.