Skip to content

Releases: tomcdj71/Shellscribe

Release v1.0.0

13 Apr 12:11

Choose a tag to compare

Shellscribe v1.0.0 - Initial Release

I'm excited to announce the first public release of Shellscribe, a powerful documentation generator for shell scripts!

Overview

Shellscribe transforms specially formatted comments in your Bash scripts into elegant Markdown documentation. It's designed to make documenting shell scripts easy, consistent, and professional.

Key Features

  • Rich Documentation Generation: Extract metadata, function definitions, arguments, examples, exit codes, and more
  • ShellCheck Integration: Detect and document ShellCheck directives with configurable display formats
  • Dependency Tracking: Document relationships between components with @requires, @provides, @calls, and @used-by tags
  • Memory Efficient: Optimized for large projects with many scripts
  • Recursive Processing: Generate documentation for entire directories of scripts
  • Configurable Output: Control formatting and output options via .scribeconf
  • Script Exclusion: Easily exclude internal scripts from documentation with @skip annotation

Installation Options

This release includes:

  • Debian/Ubuntu package (.deb)
  • Installation script for quick setup
  • Source code for manual compilation

Feedback & Contributions

This is just the beginning! I welcome your feedback and contributions to make Shellscribe even better.

Full Changelog: https://github.com/tomcdj71/Shellscribe/commits/v1.0.0