Md link plugin listed (#830)

* add plugin to list

* Add LICENSE and refactor readMarkdownWithLinks documentation

Extract reference documentation to separate file and include it via
snippet in README.

Author: vim-zz

docs/filter-function-plugins.md

@@ -36,4 +36,6 @@ JavaScript plugins that enable custom filter functions for gitStream. To learn h
 
 --8<-- "plugins/filters/isFlaggedUser/README.md"
 
+--8<-- "plugins/filters/readMarkdownWithLinks/README.md"
+
 ---

plugins/filters/readMarkdownWithLinks/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LinearB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

plugins/filters/readMarkdownWithLinks/README.md

@@ -1,3 +1,5 @@
+--8<-- "plugins/filters/readMarkdownWithLinks/reference.md"
+
 ??? note "Plugin Code: readMarkdownWithLinks"
     ```javascript
     --8<-- "plugins/filters/readMarkdownWithLinks/index.js"
@@ -7,51 +9,6 @@
     </span>
     </div>
 
-The main use case for this plugin is enhancing LinearB AI code reviews with comprehensive documentation context.
-
-### Basic Usage
-```yaml
-guidelines: |
-  {{ "REVIEW_RULES.md" | readMarkdownWithLinks | dump }}
-  
-  Additional Context:
-  {{ "README.md" | readMarkdownWithLinks(maxDepth=2) | dump }}
-```
-
-## Configuration Options
-
-- `followLinks` (boolean, default: `true`): Whether to follow internal markdown links
-- `maxDepth` (number, default: `3`): Maximum depth to follow links to prevent excessive recursion
-
-## API
-
-### `readMarkdownWithLinks(filePath, options)`
-
-Returns the combined content of the main file and all linked files as a formatted string.
-
-### `readMarkdown(filePath, options)`
-
-Returns a structured object containing:
-- `path`: Absolute path to the file
-- `content`: File content
-- `error`: Any error encountered
-- `linkedFiles`: Array of linked file objects with the same structure
-
-## Example Output
-```
-=== main.md ===
-# Main Document
-Content of main document...
-
-  === related.md ===
-  # Related Document
-  Content of related document...
-
-    === subdoc.md ===
-    # Sub Document
-    Content of sub document...
-```
-
 
 ??? example "gitStream CM Example: readMarkdownWithLinks"
     ```yaml+jinja
@@ -62,4 +19,4 @@ Content of main document...
     </span>
     </div>
 
-[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/readMarkdownWithLinks)
+[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/readMarkdownWithLinks)

plugins/filters/readMarkdownWithLinks/reference.md

@@ -0,0 +1,24 @@
+<a name="module_readMarkdownWithLinks"></a>
+
+## readMarkdownWithLinks
+Reads a markdown file and follows internal links to create a comprehensive document view. Prevents circular references and supports configurable depth limits.
+
+**Returns**: <code>string</code> - Combined content of the file and all linked files with headers, or structured object if structured option is true  
+**License**: MIT  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| filePath | <code>string</code> |  | Path to the markdown file to read |
+| [options] | <code>Object</code> | <code>{}</code> | Configuration options for link following |
+| [options.followLinks] | <code>boolean</code> | <code>true</code> | Whether to follow internal markdown links |
+| [options.maxDepth] | <code>number</code> | <code>3</code> | Maximum depth to follow links to prevent excessive recursion |
+| [options.structured] | <code>boolean</code> | <code>false</code> | Return structured data instead of combined text |
+
+**Example**  
+```js
+{{ "docs/README.md" | readMarkdownWithLinks }}
+```
+**Example**  
+```js
+{{ "docs/README.md" | readMarkdownWithLinks(maxDepth=2) }}
+```