Roll out v0.0.1

Author: coatless

README.md

@@ -48,19 +48,22 @@ Extracted scripts will be created in the same directory with names based on your
 - `my-analysis.R` - All R code extracted
 - `my-analysis.py` - All Python code extracted
 
----
 
 ## Configuration
 
-Ripper supports a single global option called `include-yaml` under `extensions.ripper`:
+Ripper supports multiple global options under `extensions.ripper`:
 
 ```yaml
 ---
+echo: true                           # Required to include code blocks in output
 filters:
   - ripper
 extensions:
   ripper:
-    include-yaml: false   # Include YAML as comments (default: true)
+    include-yaml: true               # Include YAML as comments (default: true)
+    script-links-position: "bottom"  # Position of links section (default: "bottom")
+    output-name: "my-scripts"        # Custom base name for output files (optional)
+    debug: false                     # Enable verbose logging (default: false)
 ---
 ```
 
@@ -69,6 +72,56 @@ extensions:
 - **`true` (default)**: Includes YAML frontmatter as commented lines at the top of each script
 - **`false`**: Extracts only code with no YAML comments
 
+### Option: `script-links-position`
+
+Controls where the "Script file(s)" section with links to generated scripts appears:
+
+- **`"bottom"` (default)**: Places the section at the end of the document
+- **`"top"`**: Places the section at the beginning of the document
+- **`"custom"`**: Places the section where you define a div with `id="ripper-links"` in your document
+- **`"none"`**: Suppresses the section entirely
+
+#### Custom Positioning Example
+
+- To place the section at a specific location in your document, use `script-links-position: "custom"` and add a div with the id `ripper-links`.
+
+````md
+---
+title: "My Analysis"
+filters:
+  - ripper
+extensions:
+  ripper:
+    script-links-position: "custom"
+---
+
+## Introduction
+
+Some introductory text here.
+
+::: {#ripper-links}
+:::
+
+## Analysis
+
+```{{r}}
+# Your code here
+```
+````
+
+
+### Option: `output-name`
+
+- Allows you to specify a custom base name for the generated script files instead of using the document name.
+- For example, if you set `output-name: "my-custom-name"`, rendering `my-analysis.qmd` would produce:
+  - `my-custom-name.R`
+  - `my-custom-name.py`
+
+### Option: `debug`
+
+- Enables verbose logging to help troubleshoot issues or understand the extension's behavior.
+
+
 ## Supported Languages
 
 16 languages supported with appropriate file extensions and comment styles:
@@ -92,3 +145,16 @@ extensions:
 | Perl       | .pl       | #'      |
 | PHP        | .php      | //'     |
 
+## See Also
+
+### Related Quarto Extensions
+
+1. **[sorting-hat](https://github.com/coatless-quarto/sorting-hat)**: Conditionally retain or omit code blocks by language in rendered documents. 
+  - Use with ripper to control what appears in your document while extracting all visible code to scripts.
+2. **[regurgitate](https://github.com/coatless-quarto/regurgitate)**: Automatically create code appendices in your rendered document, organized by language or document order. 
+  - Complements ripper by providing in-document code listings while ripper creates external executable files.
+
+### Historical Context
+
+Ripper's ability to extract code from Quarto documents originated a feature request I submitted in
+[`quarto-dev/quarto-cli` issue #1156](https://github.com/quarto-dev/quarto-cli/issues/1156) back on June 14, 2022.

_extensions/ripper/_extension.yml

@@ -1,6 +1,6 @@
 title: Ripper
 author: James Joseph Balamuta
-version: 0.0.0-dev.1
+version: 0.0.1
 quarto-required: ">=1.7.0"
 contributes:
   filters: