@ng-doc/keywords-loaders 22.0.0-beta.2 → 22.0.0

package/README.md

@@ -1,37 +1,28 @@
-<!-- PROJECT LOGO -->
-<br />
-<div align="center">
-  <a href="https://github.com/ng-doc/ng-doc">
-    <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px">
-  </a>
-
-<h1 align="center" style="margin-bottom: 0; border-bottom: 0">NgDoc</h1>
-  <p align="center">
-    Create user-friendly documentation for your projects with ease!
-    <br />
-    <a href="https://ng-doc.com/">Documentation</a>
-    ·
-    <a href="https://github.com/ng-doc/ng-doc/issues/new/choose">Report Bug</a>
-    ·
-    <a href="https://github.com/ng-doc/ng-doc/issues/new/choose">Request Feature</a>
-
-[![GitHub Workflow Status][build-shield]][build-url]
+# 🔗 @ng-doc/keywords-loaders
+
+Loaders that let keywords link to the Angular and RxJS docs or to another NgDoc site.
+
+It's part of [NgDoc](https://ng-doc.com/) 📚, the documentation engine for Angular projects.
+
 [![NPM][npm-shield]][npm-url]
 [![MIT License][license-shield]][license-url]
 
-  </p>
-</div>
+## 🚀 Getting started
+
+You don't need to install this package by hand. Add NgDoc to your project and it sets up
+everything it needs:
 
-<!-- ABOUT THE PROJECT -->
+```bash
+ng add @ng-doc/add
+```
 
-## About The Project
+## 📖 Learn more
 
-This library is a part of NgDoc project, that uses to create documentation
-for Angular projects, please check our [repo](https://github.com/ng-doc/ng-doc) for more details.
+- [Documentation](https://ng-doc.com/)
+- [GitHub repository](https://github.com/ng-doc/ng-doc)
+- [Report a bug or request a feature](https://github.com/ng-doc/ng-doc/issues/new/choose)
 
-[npm-shield]: https://img.shields.io/npm/v/@ng-doc/builder.svg?style=for-the-badge
-[npm-url]: https://www.npmjs.com/package/@ng-doc/builder
+[npm-shield]: https://img.shields.io/npm/v/%40ng-doc%2Fkeywords-loaders.svg?style=for-the-badge
+[npm-url]: https://www.npmjs.com/package/@ng-doc/keywords-loaders
 [license-shield]: https://img.shields.io/github/license/ng-doc/ng-doc.svg?style=for-the-badge
-[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
-[build-shield]: https://img.shields.io/github/actions/workflow/status/ng-doc/ng-doc/release.yml?style=for-the-badge&branch=release
-[build-url]: https://github.com/ng-doc/ng-doc/actions
+[license-url]: https://github.com/ng-doc/ng-doc/blob/main/LICENSE

package/index.cjs.js

@@ -105,7 +105,11 @@ function ngDocKeywordsLoader(options) {
       } = keywords[key];
       const url = `${endpoint}${path}`;
       const isGuideKeyword = key.startsWith('*');
-      if (isGuideKeyword && options.loadGuides) {
+      // Page keywords (and their anchors) start with an asterisk; they are loaded only on request.
+      if (isGuideKeyword && !options.loadGuides) {
+        return acc;
+      }
+      if (isGuideKeyword) {
         const prefix = options.guidesPrefix ?? '';
         const newKey = `*${prefix}${key.replace(/^\*/, '')}`;
         acc[newKey] = {
@@ -159,7 +163,7 @@ function rxjsPageToKeyword(page, version) {
   return [page.title, {
     title: page.title,
     url: getApiUrl(page.path, version),
-    description: `External link the RxJS documentation.`
+    description: `External link to the RxJS documentation.`
   }];
 }
 

package/package.json

@@ -1,20 +1,7 @@
 {
   "name": "@ng-doc/keywords-loaders",
-  "version": "22.0.0-beta.2",
-  "type": "commonjs",
-  "dependencies": {
-    "@ng-doc/core": "22.0.0-beta.2",
-    "node-fetch": "2.6.11"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "exports": {
-    "./package.json": "./package.json",
-    ".": "./index.cjs.js"
-  },
-  "main": "./index.cjs.js",
-  "types": "./index.d.ts",
+  "version": "22.0.0",
+  "description": "Keyword loaders that link NgDoc pages to Angular, RxJS and other NgDoc sites.",
   "keywords": [
     "angular",
     "documentation",
@@ -25,14 +12,28 @@
     "demo",
     "ng-doc"
   ],
-  "author": "Skoropad Aleksandr <alex@skoropad.dev>",
+  "homepage": "https://ng-doc.com",
+  "bugs": {
+    "url": "https://github.com/ng-doc/ng-doc/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ng-doc/ng-doc.git"
   },
-  "bugs": {
-    "url": "https://github.com/ng-doc/ng-doc/issues"
+  "license": "MIT",
+  "type": "commonjs",
+  "dependencies": {
+    "@ng-doc/core": "22.0.0",
+    "node-fetch": "2.6.11"
   },
-  "homepage": "https://ng-doc.com",
-  "license": "MIT"
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./index.cjs.js"
+  },
+  "main": "./index.cjs.js",
+  "types": "./index.d.ts",
+  "author": "Skoropad Aleksandr <alex@skoropad.dev>"
 }