feat: add contributors and badge to doc pages (#173)

* docs: added the logo * docs: title alignment to center * feat: add contributors and badge to all doc pages --------- Co-authored-by: Chau Tran <nartc7789@gmail.com>
ngxtension · Nov 24, 2023 · b468031 · b468031
1 parent 1b1efe2
commit b468031
Show file tree

Hide file tree

Showing 31 changed files with 62 additions and 0 deletions.
diff --git a/docs/src/content/docs/utilities/Components/host-binding.md b/docs/src/content/docs/utilities/Components/host-binding.md
@@ -1,6 +1,8 @@
 ---
 title: hostBinding
 description: ngxtension/host-binding
+badge: stable
+contributor: Lucas Garcia
 ---
 
 `hostBinding` is a function that returns either a _writable_ or _readonly_ signal and binds the value held in that signal to the host property passed as the first argument like `@HostBinding` would do.

diff --git a/docs/src/content/docs/utilities/Directives/click-outside.md b/docs/src/content/docs/utilities/Directives/click-outside.md
@@ -1,6 +1,8 @@
 ---
 title: clickOutside
 description: An Angular directive that is used to detect clicks outside the element.
+badge: stable
+contributor: Dale Nguyen
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Directives/repeat.md b/docs/src/content/docs/utilities/Directives/repeat.md
@@ -1,6 +1,8 @@
 ---
 title: repeat
 description: An Angular directive extending NgFor to allow iteration over a fixed number of iterations.
+badge: stable
+contributor: Chau Tran
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Directives/resize.mdx b/docs/src/content/docs/utilities/Directives/resize.mdx
@@ -1,6 +1,8 @@
 ---
 title: resize
 description: An Angular directive and function for listening to element resize events, allowing you to respond dynamically to changes in element size.
+badge: stable
+contributor: Tomer953
 ---
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';

diff --git a/docs/src/content/docs/utilities/Directives/trackby-id-prop.md b/docs/src/content/docs/utilities/Directives/trackby-id-prop.md
@@ -1,6 +1,8 @@
 ---
 title: TrackById / TrackByProp
 description: Angular directives that simplify using trackBy in *ngFor, eliminating the need for custom component methods.
+badge: stable
+contributor: Daniele Morosinotto
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Forms/if-validator.md b/docs/src/content/docs/utilities/Forms/if-validator.md
@@ -1,6 +1,8 @@
 ---
 title: ifValidator / ifAsyncValidator
 description: Utility functions to dynamically change the validation of Angular's Reactive Form.
+badge: stable
+contributor: Tomer953
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Gesture/gesture.mdx b/docs/src/content/docs/utilities/Gesture/gesture.mdx
@@ -1,6 +1,8 @@
 ---
 title: Gesture
 description: ngxtension/gestures
+badge: stable
+contributor: Chau Tran
 ---
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';

diff --git a/docs/src/content/docs/utilities/Gesture/intro.md b/docs/src/content/docs/utilities/Gesture/intro.md
@@ -1,6 +1,8 @@
 ---
 title: 'Introduction'
 description: 'ngxtension/gestures'
+badge: stable
+contributor: Chau Tran
 sidebar:
   order: 1
 ---

diff --git a/docs/src/content/docs/utilities/Injectors/active-element.md b/docs/src/content/docs/utilities/Injectors/active-element.md
@@ -1,6 +1,8 @@
 ---
 title: injectActiveElement
 description: An Angular utility to create an Observable that emits active element from the document.
+badge: stable
+contributor: Nevzat Topçu
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Injectors/assert-injector.md b/docs/src/content/docs/utilities/Injectors/assert-injector.md
@@ -1,6 +1,8 @@
 ---
 title: assertInjector
 description: ngxtension/assert-injector
+badge: stable
+contributor: Chau Tran
 ---
 
 `assertInjector` is an extension of [`assertInInjectionContext`](https://angular.io/api/core/assertInInjectionContext) that accepts a `Function` and an optional custom `Injector`

diff --git a/docs/src/content/docs/utilities/Injectors/auto-effect.md b/docs/src/content/docs/utilities/Injectors/auto-effect.md
@@ -1,6 +1,8 @@
 ---
 title: injectAutoEffect
 description: ngxtension/auto-effect
+badge: stable
+contributor: Chau Tran
 ---
 
 `injectAutoEffect` is a CIF that returns an _auto-wired_ `Effect`, hence the name `auto-effect`. This `Effect` can be used in places that do not have an **implicit** Injection Context like `ngOnInit` or `afterNextRender`

diff --git a/docs/src/content/docs/utilities/Injectors/create-injection-token.md b/docs/src/content/docs/utilities/Injectors/create-injection-token.md
@@ -1,6 +1,8 @@
 ---
 title: createInjectionToken
 description: Create an InjectionToken and return an injectFn and provideFn for it as well.
+badge: stable
+contributor: Chau Tran
 ---
 
 `createInjectionToken` is an abstraction over the creation of an [`InjectionToken`](https://angular.io/api/core/InjectionToken) and returns a tuple of `[injectFn, provideFn, TOKEN]`

diff --git a/docs/src/content/docs/utilities/Injectors/inject-destroy.md b/docs/src/content/docs/utilities/Injectors/inject-destroy.md
@@ -1,6 +1,8 @@
 ---
 title: injectDestroy
 description: ngxtension/inject-destroy
+badge: stable
+contributor: Enea Jahollari
 ---
 
 `injectDestroy` is a helper function that returns an observable that emits when the component is destroyed.

diff --git a/docs/src/content/docs/utilities/Injectors/inject-is-intersecting.md b/docs/src/content/docs/utilities/Injectors/inject-is-intersecting.md
@@ -1,6 +1,8 @@
 ---
 title: injectIsIntersecting
 description: ngxtension/inject-is-intersecting
+badge: stable
+contributor: Enea Jahollari
 ---
 
 `injectIsIntersecting` is a helper function that returns an observable that emits when the component/directive or a given element is being intersected.

diff --git a/docs/src/content/docs/utilities/Injectors/inject-lazy.md b/docs/src/content/docs/utilities/Injectors/inject-lazy.md
@@ -1,6 +1,8 @@
 ---
 title: injectLazy
 description: ngxtension/inject-lazy
+badge: stable
+contributor: Enea Jahollari
 ---
 
 `injectLazy` is a helper function that allows us to lazily load a service or any kind of Angular provider.

diff --git a/docs/src/content/docs/utilities/Injectors/inject-params.md b/docs/src/content/docs/utilities/Injectors/inject-params.md
@@ -1,6 +1,8 @@
 ---
 title: injectParams
 description: ngxtension/inject-params
+badge: stable
+contributor: Enea Jahollari
 ---
 
 `injectParams` is a helper function that allows us to inject params from the current route as a signal.

diff --git a/docs/src/content/docs/utilities/Injectors/inject-query-params.md b/docs/src/content/docs/utilities/Injectors/inject-query-params.md
@@ -1,6 +1,8 @@
 ---
 title: injectQueryParams
 description: ngxtension/inject-query-params
+badge: stable
+contributor: Enea Jahollari
 ---
 
 `injectQueryParams` is a helper function that allows us to inject query params from the current route as a signal.

diff --git a/docs/src/content/docs/utilities/Injectors/navigation-end.md b/docs/src/content/docs/utilities/Injectors/navigation-end.md
@@ -1,6 +1,8 @@
 ---
 title: injectNavigationEnd
 description: An Angular utility to create an Observable that emits NavigationEnd events from the Angular Router.
+badge: stable
+contributor: Mateusz Stefańczyk
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Intl/intl.md b/docs/src/content/docs/utilities/Intl/intl.md
@@ -1,6 +1,8 @@
 ---
 title: Intl
 description: Additional Intl Utilities for formatting numbers, strings, and other objects.
+badge: stable
+contributor: Ion Prodan
 ---
 
 This is a collection of pipes designed for Angular applications that leverage the [Intl API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl).

diff --git a/docs/src/content/docs/utilities/Miscellaneous/singleton-proxy.md b/docs/src/content/docs/utilities/Miscellaneous/singleton-proxy.md
@@ -1,6 +1,8 @@
 ---
 title: createSingletonProxy
 description: ngxtension/singleton-proxy
+badge: stable
+contributor: Chau Tran
 ---
 
 `createSingletonProxy` creates a singleton instance of a given class when a property within it is accessed, not before.

diff --git a/docs/src/content/docs/utilities/Operators/debug.md b/docs/src/content/docs/utilities/Operators/debug.md
@@ -1,6 +1,8 @@
 ---
 title: debug
 description: An RxJS operator that helps to debug what happens in an observable pipeline, it'll console.log all emitted values + final events (console.warn completed or console.error).
+badge: stable
+contributor: Daniele Morosinotto
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Operators/map-skip-undefined.md b/docs/src/content/docs/utilities/Operators/map-skip-undefined.md
@@ -1,6 +1,8 @@
 ---
 title: mapSkipUndefined
 description: An RxJS operator that allows applying a transform function to each value of the observable in (same as map), but with the ability to skip (filter out) some values if the function explicitly returns undefined or simply doesn't return anything for same code-path (implicit return undefined).
+badge: stable
+contributor: Daniele Morosinotto
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Operators/reduce-array.md b/docs/src/content/docs/utilities/Operators/reduce-array.md
@@ -1,6 +1,8 @@
 ---
 title: reduceArray
 description: An RxJS operator designed to apply a reduce function to an array within an Observable stream, simplifying array transformations.
+badge: stable
+contributor: Tomer953
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Operators/rx-effect.md b/docs/src/content/docs/utilities/Operators/rx-effect.md
@@ -1,6 +1,8 @@
 ---
 title: rxEffect
 description: ngxtension/rx-effect
+badge: stable
+contributor: Lucas Garcia
 ---
 
 `rxEffect` is a utility function that helps you create a side effect with rxjs, returning an already well handled `Subscription` with `takeUntilDestroyed` within it.

diff --git a/docs/src/content/docs/utilities/Pipes/call-apply.md b/docs/src/content/docs/utilities/Pipes/call-apply.md
@@ -1,6 +1,8 @@
 ---
 title: CallPipe / ApplyPipe
 description: Standalone Angular pipes for invoking pure functions with arguments, leveraging Angular's pure pipe memoization.
+badge: stable
+contributor: Daniele Morosinotto
 ---
 
 ## Import

diff --git a/docs/src/content/docs/utilities/Signals/computed-from.md b/docs/src/content/docs/utilities/Signals/computed-from.md
@@ -1,6 +1,8 @@
 ---
 title: computedFrom
 description: ngxtension/computed-from
+badge: stable
+contributor: Enea Jahollari
 ---
 
 `computedFrom` is a helper function that combines the values of `Observable`s or `Signal`s and emits the combined value.

diff --git a/docs/src/content/docs/utilities/Signals/computed.md b/docs/src/content/docs/utilities/Signals/computed.md
@@ -1,6 +1,8 @@
 ---
 title: computed/extendedComputed
 description: ngxtension/computed
+badge: stable
+contributor: Chau Tran
 ---
 
 `computed` / `extendedComputed` is an extension of Angular's `computed`. The main difference is `extendedComputed` callback is invoked with the previously computed value. This providers better DX for cases where the consumers need conditional computed and the result should have the previously computed value when a condition does not pass.

diff --git a/docs/src/content/docs/utilities/Signals/connect.md b/docs/src/content/docs/utilities/Signals/connect.md
@@ -1,6 +1,8 @@
 ---
 title: connect
 description: ngxtension/connect
+badge: stable
+contributor: Enea Jahollari
 ---
 
 `connect` is a utility function that connects a signal to an observable and returns a subscription. The subscription is automatically unsubscribed when the component is destroyed. If it's not called in an injection context, it must be called with an injector or DestroyRef.

diff --git a/docs/src/content/docs/utilities/Signals/signal-slice.md b/docs/src/content/docs/utilities/Signals/signal-slice.md
@@ -1,6 +1,8 @@
 ---
 title: signalSlice
 description: ngxtension/signalSlice
+badge: stable
+contributor: Josh Morony
 ---
 
 `signalSlice` is loosely inspired by the `createSlice` API from Redux Toolkit. The general idea is that it allows you to declaratively create a "slice" of state. This state will be available as a **readonly** signal.

diff --git a/docs/src/content/docs/utilities/Signals/to-lazy-signal.md b/docs/src/content/docs/utilities/Signals/to-lazy-signal.md
@@ -1,6 +1,8 @@
 ---
 title: toLazySignal
 description: ngxtension/to-lazy-signal
+badge: stable
+contributor: Evgeniy OZ
 ---
 
 Using `toLazySignal()`, you can save some requests or improve performance.

diff --git a/docs/src/content/docs/utilities/Stores/create-effect.md b/docs/src/content/docs/utilities/Stores/create-effect.md
@@ -1,6 +1,8 @@
 ---
 title: createEffect
 description: ngxtension/create-effect
+badge: stable
+contributor: Chau Tran
 ---
 
 `createEffect` is a standalone version of [NgRx ComponentStore Effect](https://ngrx.io/guide/component-store/effect)