CRYSTAL-DOC(1)   Crystal Compiler Command Line Reference Guide  CRYSTAL-DOC(1)

<?><?><?> (NAME)
       crystal-docs - <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       crystal docs [options] [programfile] [--] [arguments]

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?>
       <?><?><?><?><?><?><?> <?> <?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?><?><?>
       <?><?> Markdown. <?><?><?><?><?> <?><?> <?><?><?><?> HTML <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?> docs/ <?><?><?><?><?>
       <?><?><?><?><?><?>. <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?><?> <?>
       <?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
       <?><?> <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?>
       <?><?><?><?><?><?>:
       <https://crystal-lang.org/docs/conventions/documenting_code.html>.

<?><?><?><?><?><?><?><?> (OPTIONS)
       --project-name NAME
           <?><?><?><?><?> <?><?><?> <?><?><?><?><?>. <?><?> <?><?><?><?>
           <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?> <?><?><?><?> shard.yml
           <?><?><?><?><?><?><?> <?><?><?><?><?><?>.

           <?><?> <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?>.

       --project-version VERSION
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>. <?><?> <?><?><?><?>
           <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> git
           <?><?> <?><?><?><?> shard.yml <?><?><?><?><?><?><?>
           <?><?><?><?><?><?>.

           <?><?> <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?>.

       --json-config-url URL
           <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?> (URL)
           <?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?>
           <?><?><?><?><?><?><?><?> (<?><?><?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>).

       --source-refname REFNAME
           <?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?>
           (<?><?><?><?><?> <?><?> git<?> <?><?> <?><?><?><?><?>). <?><?>
           <?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> git
           <?><?><?><?><?><?><?> <?><?><?><?><?><?>.

           <?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?>
           <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?>
           <?><?><?>.

       --source-url-pattern URL
           <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> (URL) <?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?>. <?><?> <?><?><?><?>
           <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?> git
           (<?><?><?><?><?> origin <?><?> <?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?>) <?> <?><?><?><?><?><?><?> <?><?><?><?><?> URL
           <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?><?>.

           <?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?><?><?><?>:

           %{refname}
               <?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?>

           %{path}
               <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?>
               <?><?><?><?>

           %{filename}
               <?><?><?> <?><?><?><?> (basename) <?><?><?><?> <?><?><?><?>

           %{line}
               <?><?><?><?><?> <?><?>

           <?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?>
           <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?>
           <?><?><?>.

       -o DIR, --output DIR
           <?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
           (<?><?><?><?><?><?><?>: ./docs).

       -b URL, --canonical-base-url URL
           <?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?>
           (URL) <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?>
           <?><?><?><?> <?><?><?><?><?> rel="canonical".

       -b URL, --sitemap-base-url URL
           <?><?><?><?><?> URL <?><?><?><?> <?><?><?><?> <?><?><?><?>
           <?><?><?><?> (sitemap). <?><?><?><?> <?><?><?><?> <?><?><?><?>
           <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?>
           <?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?>.

       --sitemap-priority PRIO
           <?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
           (<?><?><?><?><?><?><?>: 1.0).

       --sitemap-changefreq FREQ
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> (changefreq)
           <?><?><?><?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
           (<?><?><?><?><?><?><?>: never).

crystal 1.21.0                    2026-07-23                    CRYSTAL-DOC(1)