https://github.com/oasisdigital/ng-doc-portal

An Nx plugin & Angular module set that allows you to build documentation applications natively in Angular! This project has a focus on documenting Angular components (e.g. component library), but it can be used for any documentation needs you might have in Angular.
https://github.com/oasisdigital/ng-doc-portal

Last synced: 6 days ago
JSON representation

An Nx plugin & Angular module set that allows you to build documentation applications natively in Angular! This project has a focus on documenting Angular components (e.g. component library), but it can be used for any documentation needs you might have in Angular.

• Host: GitHub
• URL: https://github.com/oasisdigital/ng-doc-portal
• Owner: OasisDigital
• Created: 2022-11-21T20:07:16.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-17T17:34:56.000Z (about 1 year ago)
• Last Synced: 2023-09-19T15:51:06.554Z (about 1 year ago)
• Language: TypeScript
• Size: 1.27 MB
• Stars: 3
• Watchers: 12
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ng Doc Portal Project

This is the root of the nx workspace containing the two packages:

- [`ng-doc-portal`](./libs/ng-doc-portal/README.md)

- [`ng-doc-portal-plugin`](./libs/ng-doc-portal-plugin/README.md)

## [`ng-doc-portal`](./libs/ng-doc-portal/README.md) Overview

This part of the repo is dedicated to the angular application that runs and displays the document pages.

This contains the component set we provide, root module/routing system, DI configuration system and css styling.

## [`ng-doc-portal-plugin`](./libs/ng-doc-portal-plugin/README.md) Overview

This part of the repo contains the `nx` generators/executors we have developed.

The executors are responsible for running our custom compiler along with a normal angular serve/build.

The generators are responsible for creating a default `ng-doc-portal` configured angular application or generating a single `.doc-page` file.

## Getting Setup

Run `npm install` to get the project setup.

## Running Example Application

Run `npm start` to run the example `ng-doc-portal` application.

## Building Example Application

Run `npm build` to build the example `ng-doc-portal` application.

## Publishing

Publishing is automatically done via the Github release process.

Once a release is created a workflow will be triggered to update, publish, and commit the `package.json` files of the npm packages in the repo.