Prepare release v0.1.0

Author: ewels

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [Version 0.1.0](https://github.com/ewels/nf-docs/releases/tag/v0.1.0) - 2026-02-20
+
+Initial release of `nf-docs`.
+
+### Added
+
+- `nf-docs generate` command to extract and render pipeline documentation in HTML, JSON, YAML, and
+  Markdown formats
+- `nf-docs inspect` command for a dry-run summary of what nf-docs finds in a pipeline
+- `nf-docs download-lsp` and `nf-docs clear-cache` utility commands
+- Extraction of pipeline inputs from `nextflow_schema.json` and config parameters from
+  `nextflow.config`
+- Process, workflow, and function documentation via the Nextflow Language Server (LSP), including
+  Groovydoc docstrings and typed I/O declarations
+- nf-core `meta.yml` support for enriched module and subworkflow documentation
+- Git-aware source code deep links for GitHub, GitLab, and Bitbucket
+- XDG-compliant caching keyed by content hash and package version, with automatic invalidation
+- User config file at `~/.config/nf-docs/config.yaml` for persistent defaults

docs/index.md

@@ -30,12 +30,18 @@ Python or Javadoc for Java.
 
     One file per section — integrates with static site generators like MkDocs or Zensical.
 
--   :material-code-json:{ .lg .middle } __JSON / YAML__
+-   :material-code-json:{ .lg .middle } __JSON__
 
     ---
 
     Machine-readable structured data for CI/CD pipelines and custom integrations.
 
+-   :material-code-yaml:{ .lg .middle } __YAML__
+
+    ---
+
+    Human and machine-readable structured data for CI/CD pipelines and custom integrations.
+
 </div>
 
 <!-- prettier-ignore-end -->

docs/running.md

@@ -34,8 +34,25 @@ nf-docs inspect /path/to/pipeline
 
 # Pre-download the Language Server JAR
 nf-docs download-lsp
+
+# Clear the extraction cache for a specific pipeline
+nf-docs clear-cache /path/to/pipeline
+
+# Clear the entire extraction cache
+nf-docs clear-cache --all
 ```
 
+## Caching
+
+nf-docs caches extraction results to avoid re-running the Language Server on every invocation.
+Cached data is stored in `~/.cache/nf-docs/` (respects `$XDG_CACHE_HOME`).
+
+The cache is keyed by pipeline path, a SHA-256 hash of all pipeline source files, and the nf-docs
+version, so it is automatically invalidated whenever files change or nf-docs is upgraded.
+
+Use `--no-cache` to skip the cache for a single run, or `nf-docs clear-cache` to remove entries
+manually.
+
 ## Output formats
 
 ### HTML

pyproject.toml

@@ -59,8 +59,8 @@ nf-docs = "nf_docs.cli:main"
 nf-docs-tailwind = "nf_docs.tailwind:main"
 
 [project.urls]
-Homepage = "https://github.com/ewels/nf-docs"
-Documentation = "https://github.com/ewels/nf-docs#readme"
+Homepage = "https://ewels.github.io/nf-docs/"
+Documentation = "https://ewels.github.io/nf-docs/"
 Repository = "https://github.com/ewels/nf-docs"
 Issues = "https://github.com/ewels/nf-docs/issues"