feat(docs): add ng-doc

Author: Char2sGu

.gitignore

@@ -1,13 +1,13 @@
 /node_modules
 /dist
 /.angular/cache
+/.nx/cache
 /.eslintcache
 
+/ng-doc
+
 /.vscode/*
 !/.vscode/settings.json
 !/.vscode/tasks.json
 !/.vscode/launch.json
 !/.vscode/extensions.json
-
-
-.nx/cache

docs/package.json

@@ -10,6 +10,9 @@
     "@angular/forms": "17.x.x",
     "@angular/platform-browser": "17.x.x",
     "@angular/router": "17.x.x",
+    "@ng-doc/app": "17.5.5",
+    "@ng-doc/core": "17.5.5",
+    "@ng-doc/ui-kit": "17.5.5",
     "rxjs": "7.x.x",
     "tslib": "2.x.x"
   }

docs/project.json

@@ -11,17 +11,39 @@
   "prefix": "adoc",
   "targets": {
     "build": {
-      "executor": "@angular-devkit/build-angular:application",
+      "executor": "@ng-doc/builder:application",
       "options": {
         "outputPath": "dist/docs",
         "index": "docs/src/index.html",
         "browser": "docs/src/main.ts",
         "polyfills": ["zone.js"],
         "tsConfig": "docs/tsconfig.app.json",
         "inlineStyleLanguage": "scss",
-        "assets": ["docs/src/favicon.ico", "docs/src/assets"],
-        "styles": ["docs/src/styles.scss"],
-        "scripts": []
+        "assets": [
+          {
+            "glob": "**/*",
+            "input": "node_modules/@ng-doc/app/assets",
+            "output": "assets/ng-doc/app"
+          },
+          {
+            "glob": "**/*",
+            "input": "node_modules/@ng-doc/ui-kit/assets",
+            "output": "assets/ng-doc/ui-kit"
+          },
+          {
+            "glob": "**/*",
+            "input": "ng-doc/docs/assets",
+            "output": "assets/ng-doc"
+          },
+          "docs/src/favicon.ico",
+          "docs/src/assets"
+        ],
+        "styles": [
+          "node_modules/@ng-doc/app/styles/global.css",
+          "docs/src/styles.scss"
+        ],
+        "scripts": [],
+        "allowedCommonJsDependencies": ["@ng-doc/core"]
       },
       "configurations": {
         "production": {
@@ -48,7 +70,7 @@
       "defaultConfiguration": "production"
     },
     "serve": {
-      "executor": "@angular-devkit/build-angular:dev-server",
+      "executor": "@ng-doc/builder:dev-server",
       "configurations": {
         "production": {
           "buildTarget": "docs:build:production"

docs/src/app/app.component.html

@@ -0,0 +1,9 @@
+<ng-doc-root>
+  <ng-doc-navbar [leftContent]="leftContent">
+    <ng-template #leftContent>
+      <h3 style="margin: 0">MyAwesomeDoc</h3>
+    </ng-template>
+  </ng-doc-navbar>
+  <ng-doc-sidebar />
+  <router-outlet />
+</ng-doc-root>

docs/src/app/app.component.ts

@@ -1,10 +1,20 @@
 import { Component } from '@angular/core';
 import { RouterOutlet } from '@angular/router';
+import {
+  NgDocNavbarComponent,
+  NgDocRootComponent,
+  NgDocSidebarComponent,
+} from '@ng-doc/app';
 
 @Component({
   selector: 'adoc-root',
   standalone: true,
-  imports: [RouterOutlet],
+  imports: [
+    RouterOutlet,
+    NgDocRootComponent,
+    NgDocNavbarComponent,
+    NgDocSidebarComponent,
+  ],
   templateUrl: './app.component.html',
   styleUrl: './app.component.scss',
 })

docs/src/app/app.config.ts

@@ -1,8 +1,37 @@
+import {
+  provideHttpClient,
+  withFetch,
+  withInterceptorsFromDi,
+} from '@angular/common/http';
 import { ApplicationConfig } from '@angular/core';
-import { provideRouter } from '@angular/router';
-
-import { routes } from './app.routes';
+import { provideAnimations } from '@angular/platform-browser/animations';
+import { provideRouter, withInMemoryScrolling } from '@angular/router';
+import {
+  NG_DOC_DEFAULT_PAGE_PROCESSORS,
+  NG_DOC_DEFAULT_PAGE_SKELETON,
+  NgDocDefaultSearchEngine,
+  provideMainPageProcessor,
+  provideNgDocApp,
+  providePageSkeleton,
+  provideSearchEngine,
+} from '@ng-doc/app';
+import { NG_DOC_ROUTING, provideNgDocContext } from '@ng-doc/generated';
 
 export const appConfig: ApplicationConfig = {
-  providers: [provideRouter(routes)],
+  providers: [
+    provideAnimations(),
+    provideRouter(
+      NG_DOC_ROUTING,
+      withInMemoryScrolling({
+        scrollPositionRestoration: 'enabled',
+        anchorScrolling: 'enabled',
+      }),
+    ),
+    provideHttpClient(withInterceptorsFromDi(), withFetch()),
+    provideNgDocContext(),
+    provideNgDocApp(),
+    provideSearchEngine(NgDocDefaultSearchEngine),
+    providePageSkeleton(NG_DOC_DEFAULT_PAGE_SKELETON),
+    provideMainPageProcessor(NG_DOC_DEFAULT_PAGE_PROCESSORS),
+  ],
 };