Roll init filter build

Author: coatless

.github/workflows/publish-website.yml

@@ -0,0 +1,68 @@
+on:
+    push:
+      branches: [main, master]
+    release:
+        types: [published]
+    workflow_dispatch: {}
+      
+name: demo-website
+
+jobs:
+    demo-page:
+        runs-on: ubuntu-latest
+        # Only restrict concurrency for non-PR jobs
+        concurrency:
+            group: quarto-publish-${{ github.event_name != 'pull_request' || github.run_id }}
+        permissions:
+            contents: read
+            pages: write
+            id-token: write
+        steps:
+        
+        - name: "Check out repository"
+          uses: actions/checkout@v4
+
+        # To render using knitr, we need a few more setup steps...
+        # If we didn't want the examples to use `engine: knitr`, we could
+        # skip a few of the setup steps.
+        - name: "Setup R"
+          uses: r-lib/actions/setup-r@v2
+
+        - name: "Setup R dependencies for Quarto's knitr engine"
+          uses: r-lib/actions/setup-r-dependencies@v2
+          with:
+            packages:
+                any::knitr
+                any::rmarkdown
+                any::downlit
+                any::xml2
+                any::reticulate
+
+        - name: "Set up Quarto"
+          uses: quarto-dev/quarto-actions/setup@v2
+          with:
+            version: "pre-release"
+
+        # Render the Quarto file
+        - name: "Render working directory"
+          uses: quarto-dev/quarto-actions/render@v2
+          with:
+            path: "docs"
+
+
+        # Upload a tar file that will work with GitHub Pages
+        # Make sure to set a retention day to avoid running into a cap
+        # This artifact shouldn't be required after deployment onto pages was a success.
+        - name: Upload Pages artifact
+          uses: actions/upload-pages-artifact@v3
+          with: 
+            retention-days: 1
+            path: 'docs/_site'
+
+        
+        # Use an Action deploy to push the artifact onto GitHub Pages
+        # This requires the `Action` tab being structured to allow for deployment
+        # instead of using `docs/` or the `gh-pages` branch of the repository
+        - name: Deploy to GitHub Pages
+          id: deployment
+          uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,4 @@
+/.luarc.json
+.DS_Store
+/docs/_site/
+*_files/

README.md

@@ -1,25 +1,109 @@
-# Quarto Extension Development with Lua in a Devcontainer
+# linkrot <img src="docs/linkrot-animated-logo.svg" align ="right" alt="" width ="150"/>
 
-This repository houses a devcontainer that setups a [Quarto extension development environment](https://quarto.org/docs/extensions/lua.html). The container is setup to work with [GitHub Codespaces](https://github.com/features/codespaces) to instantly have a cloud-based developer workflow.
+A Quarto extension that automatically checks for broken external links in your documents during rendering.
 
-You can try out the Codespace by clicking on the following button:
+## Installation
 
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/coatless-devcontainer/quarto-extension-dev?quickstart=1)
+To install the `linkrot` Quarto extension, follow these steps:
 
-**Note:** Codespaces are available to Students and Teachers for free [up to 180 core hours per month](https://docs.github.com/en/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom#about-github-codespaces) through [GitHub Education](https://education.github.com/). Otherwise, you will have [up to 60 core hours and 15 GB free per month](https://github.com/features/codespaces#pricing).
+1. Open your terminal.
+2. Execute the following command:
 
-The devcontainer contains:
+```sh
+quarto add coatless-quarto/linkrot
+```
 
-- The latest [pre-release](https://quarto.org/docs/download/prerelease) version of Quarto.
-- [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto).
-- [Lua LSP VS Code Extension](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) for Lua code intelligence.
-- [GitHub copilot VS Code Extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot).
-- `R` and `Python`
-- `knitr` and `jupyter`
+This command will download and install the Quarto extension under the `_extensions` subdirectory of your Quarto project.
+If you are using version control, ensure that you include this directory in your repository.
 
-## References
+### Requirements
+
+- Quarto >= 1.7.0
+- `curl` command-line tool:
+  - **Linux/macOS**: Usually pre-installed
+  - **Windows**: Built-in on Windows 10 (1803+) and Windows 11
+  - **Older Windows**: Install [curl for Windows](https://curl.se/windows/) or use Git Bash which includes curl
+
+## Usage
+
+Add the extension to your document's YAML header:
+
+```yaml
+---
+title: "My Document"
+filters:
+  - linkrot
+---
+```
+
+The extension will automatically check all external HTTP/HTTPS links during rendering and report any broken links.
+
+## Configuration
+
+You can configure linkrot's behavior in your document's YAML using the `extensions.linkrot` key:
+
+```yaml
+---
+title: "My Document"
+filters:
+  - linkrot
+extensions:
+  linkrot:
+    fail-on-error: false      # Set to true to fail the build if broken links are found
+    timeout: 10               # Timeout in seconds for each URL check
+    user-agent: "Quarto-Linkrot/1.0"  # User agent string for requests
+    cache-results: true       # Cache results to avoid checking the same URL multiple times
+    debug: false              # Enable debug logging
+    output-file: null         # Write results to a file (e.g., "linkrot-report.txt")
+    skip-patterns:            # List of regex patterns to skip
+      - "example\\.com"
+      - "localhost"
+---
+```
+
+### Configuration Options
+
+#### fail-on-error** (default: `false`)
+
+- If set to `true`, the build will fail if any broken links are detected. Useful for CI/CD pipelines.
+
+#### timeout (default: `10`)
+
+- Maximum time in seconds to wait for each URL to respond.
+
+#### user-agent (default: `"Quarto-Linkrot/1.0"`)
+
+- User agent string sent with HTTP requests.
+
+#### cache-results (default: `true`)
+
+- Cache URL check results to avoid repeatedly checking the same URL in a document.
+
+#### debug (default: `false`)
+
+- Enable debug logging to see detailed information about what linkrot is doing.
+
+#### output-file (default: `null`)
+
+- Path to a file where results will be written. If not specified, results are only shown in the console.
+
+#### skip-patterns
+
+- List of regex patterns. URLs matching any pattern will be skipped (not checked).
+
+## Example Output
+
+When the extension runs, you'll see output like this in the console:
+
+```default
+=== Linkrot Results ===
+Total external links checked: 15
+Broken links found: 2
+
+Broken links:
+  1. [Example Link] https://example.com/broken-page (Status: 404)
+  2. [Another Link] https://nonexistent-site-xyz123.com (Status: timeout/error)
+```
+
+You can also specify an output file to save the results.
 
-- [Quarto: Lua API Reference](https://quarto.org/docs/extensions/lua-api.html)
-- [Quarto: Lua Development](https://quarto.org/docs/extensions/lua.html)
-- [Pandoc: Lua Filters](https://pandoc.org/lua-filters.html)
-- [Lua: Manual](https://www.lua.org/manual/5.4/)

_extensions/linkrot/_extension.yml

@@ -0,0 +1,7 @@
+title: linkrot
+author: James Joseph Balamuta
+version: 0.0.0-dev.1
+quarto-required: ">=1.7.0"
+contributes:
+  filters:
+    - linkrot.lua