installation

Commandes d'installation supplémentaires

macOS

Homebrewvérifié · 100%

brew install sourcedocs

local Homebrew formula metadata

aperçu

Résumé du paquet

Generate Markdown files from inline source code documentation

Liens du projet

Page d'accueil

Commandes et alias

sourcedocs

historique

Historique du projet et usages

SourceDocs is a Swift command-line documentation generator that writes Markdown reference documentation from inline source comments, targeting repositories that want docs to live beside their code.

Historique du projet

The GitHub repository was created in October 2017, with the changelog marking 0.1.0 as the initial release. Early releases refined output directories, Markdown generation, and command-line behavior.

The 1.0.0 release added `SourceDocsLib` so other Swift tools could generate documentation, required Swift 5.1 or higher, added a `package` command for Swift packages, and migrated to Swift Argument Parser. Later 1.x and 2.x releases tracked Swift, Xcode, and package-generation changes.

Historique d'adoption

The README positions SourceDocs alongside Sphinx and Jazzy, but with a Markdown-in-repository model intended for GitHub, Bitbucket, and GitHub Pages workflows. It is distributed through Homebrew and source builds.

Modes d'utilisation

Users run `sourcedocs generate` from a Swift package or Xcode project root. The tool can generate documentation for all Swift Package Manager modules, a named module, package descriptions, and reproducible docs.

Pourquoi les passionnés de paquets s'y intéressent

Package nerds care because SourceDocs treats generated API docs as versioned Markdown artifacts rather than as an external hosted site. That makes it fit package repositories, CI diffs, and lightweight documentation publishing.

Chronologie

2017: Repository created and 0.1.0 initial release published.
2017: 0.4.0 changed default output to `Documentation/Reference` and revised command-line handling.
2020: 1.0.0 added `SourceDocsLib`, Swift 5.1 requirement, Swift Package documentation, and Swift Argument Parser.
2020: 1.1.0 added all-module generation and reproducible docs.
2021: 2.0.0 updated for Xcode 13.
2022: 2.0.1 updated for Xcode 13.3 and Swift 5.6.

Related projects

SourceDocs is conceptually related to Jazzy and Sphinx, both named in its README.
SourceKitten is listed by SourceKitten as a project built with SourceKitten and SourceDocs uses Swift tooling to inspect source for documentation.

Sources

posture de sécurité

Niveau de risque : vert

narrow executable package without higher-risk signals.

Classificateur de risque

risque vert · confiance faible · appliance

Pourquoi

narrow executable package without higher-risk signals

Signaux

metadata:no-higher-risk-signals

Comportement d'installation

Aucune métadonnée de bottle Homebrew n’a été enregistrée.

Revue recommandée

Avant une utilisation sans surveillance par un agent, vérifiez si l'outil lit des identifiants en clair, écrit un état distant, publie des artefacts ou lance des plugins.

exécutables

Exécutables installés

Commande	Type	Exposition	Note
`sourcedocs`	exécutable	exécutable indexé	Découvert depuis l'index local des exécutables.

fraîcheur

Version et fraîcheur

Ces signaux séparent l'âge de génération de la page, l'activité du gestionnaire de paquets et la comparaison avec les versions amont. Un retard de version n'est signalé que lorsqu'une URL de preuve et des versions comparables sont présentes.

page générée2026-08-03

version du gestionnaire2.0.1

gestionnaire mis à jour

données localesinconnu

amontnon disponible

dernière version détectéenon détecté

OKAucun avertissement de fraîcheur n'a été généré.

métadonnées d'installation

Métadonnées du paquet

Clé du paquet	brew:sourcedocs
Version	2.0.1
Gestionnaire de paquets	Homebrew
Page d'accueil	https://github.com/SourceDocs/SourceDocs
Dépôt	https://github.com/SourceDocs/SourceDocs
Bouteille	non enregistré
Service	aucun déclaré

graphe de paquets

Les liens viennent du graphe local de relations entre paquets, des suppléments, des dépendances, des correspondances d'écosystèmes et de l'appartenance aux hubs.

piste source

Généré depuis les données du dépôt

Cette page est servie par av-web depuis l'artéfact SQLite privé des paquets généré par scripts/generate-pkg-sqlite.py.

Combined YAML source

View the package source record on GitHub.

combined/sourcedocs.yml

Sources utilisées

Geiger risk classifier
cross-ecosystem install command graph
curated package history
pkg.so package database
pkgdb category and tag curation

Installer sourcedocs avec Homebrew