quarto-dev / quarto-cli

Open-source scientific and technical publishing system built on Pandoc.
https://quarto.org
Other
3.6k stars 294 forks source link

quarto --help: Entry 'publish' ends in an incomplete sentence #7247

Closed HenrikBengtsson closed 9 months ago

HenrikBengtsson commented 9 months ago

Not how the publish line below ends in Available providers include:.

$ quarto --help

  Usage:   quarto 
  Version: 1.3.450

  Description:

    Quarto CLI

  Options:

    -h, --help     - Show this help.                            
    -V, --version  - Show the version number for this program.  

  Commands:

    render          [input] [args...]     - Render files or projects to various document types.        
    preview         [file] [args...]      - Render and preview a document or website project.          
    serve           [input]               - Serve a Shiny interactive document.                        
    create          [type] [commands...]  - Create a Quarto project or extension                       
    create-project  [dir]                 - Create a project for rendering multiple documents          
    convert         <input>               - Convert documents to alternate representations.            
    pandoc          [args...]             - Run the version of Pandoc embedded within Quarto.          
    run             [script] [args...]    - Run a TypeScript, R, Python, or Lua script.                
    add             <extension>           - Add an extension to this folder or project                 
    install         [target...]           - Installs an extension or global dependency.                
    publish         [provider] [path]     - Publish a document or project. Available providers include:
    check           [target]              - Verify correct functioning of Quarto installation.         
    help            [command]             - Show this help or the help of a sub-command. 
cderv commented 9 months ago

Thanks !

I think this is newline misplaced. Short description is the first line from the long description

 quarto publish help

  Usage:   quarto publish [provider] [path]
  Version: 99.9.9

  Description:

    Publish a document or project. Available providers include:

     - Quarto Pub (quarto-pub)
     - GitHub Pages (gh-pages)
     - Posit Connect (connect)
     - Netlify (netlify)
     - Confluence (confluence)

    Accounts are configured interactively during publishing.
    Manage/remove accounts with: quarto publish accounts

  Options:

    -h, --help              - Show this help.
    --id          <id>      - Identifier of content to publish
    --server      <server>  - Server to publish to
    --token       <token>   - Access token for publising provider
    --no-render             - Do not render before publishing.
    --no-prompt             - Do not prompt to confirm publishing destination
    --no-browser            - Do not open a browser to the site after publishing
    --log         <file>    - Path to log file
    --log-level   <level>   - Log level (info, warning, error, critical)
    --log-format  <format>  - Log format (plain, json-stream)
    --quiet                 - Suppress console output.
    --profile               - Active project profile(s)

  Commands:

    help  [command]  - Show this help or the help of a sub-command.

  Examples:

    Publish project (prompt for provider):  quarto publish
    Publish document (prompt for provider): quarto publish document.qmd
    Publish project to Netlify:             quarto publish netlify
    Publish with explicit target:           quarto publish netlify --id DA36416-F950-4647-815C-01A24233E294
    Publish project to GitHub Pages:        quarto publish gh-pages
    Publish project to Posit Connect:       quarto publish connect
    Publish with explicit credentials:      quarto publish connect --server example.com --token 01A24233E294
    Publish without confirmation prompt:    quarto publish --no-prompt
    Publish without rendering:              quarto publish --no-render
    Publish without opening browser:        quarto publish --no-browser
    Manage/remove publishing accounts:      quarto publish accounts

We should probably move to a new lien the Available providers include: part.

cderv commented 9 months ago
> quarto help

  Usage:   quarto
  Version: 99.9.9

  Description:

    Quarto CLI

  Options:

    -h, --help     - Show this help.
    -V, --version  - Show the version number for this program.

  Commands:

    render          [input] [args...]     - Render files or projects to various document types.
    preview         [file] [args...]      - Render and preview a document or website project.
    serve           [input]               - Serve a Shiny interactive document.
    create          [type] [commands...]  - Create a Quarto project or extension
    create-project  [dir]                 - Create a project for rendering multiple documents
    convert         <input>               - Convert documents to alternate representations.
    pandoc          [args...]             - Run the version of Pandoc embedded within Quarto.
    typst           [args...]             - Run the version of Typst embedded within Quarto.
    run             [script] [args...]    - Run a TypeScript, R, Python, or Lua script.
    add             <extension>           - Add an extension to this folder or project
    install         [target...]           - Installs an extension or global dependency.
    publish         [provider] [path]     - Publish a document or project to a provider.
    check           [target]              - Verify correct functioning of Quarto installation.
    help            [command]             - Show this help or the help of a sub-command.
> quarto publish help

  Usage:   quarto publish [provider] [path]
  Version: 99.9.9

  Description:

    Publish a document or project to a provider.

    Available providers include:

     - Quarto Pub (quarto-pub)
     - GitHub Pages (gh-pages)
     - Posit Connect (connect)
     - Netlify (netlify)
     - Confluence (confluence)

    Accounts are configured interactively during publishing.
    Manage/remove accounts with: quarto publish accounts

  Options:

    -h, --help              - Show this help.
    --id          <id>      - Identifier of content to publish
    --server      <server>  - Server to publish to
    --token       <token>   - Access token for publising provider
    --no-render             - Do not render before publishing.
    --no-prompt             - Do not prompt to confirm publishing destination
    --no-browser            - Do not open a browser to the site after publishing
    --log         <file>    - Path to log file
    --log-level   <level>   - Log level (info, warning, error, critical)
    --log-format  <format>  - Log format (plain, json-stream)
    --quiet                 - Suppress console output.
    --profile               - Active project profile(s)

  Commands:

    help  [command]  - Show this help or the help of a sub-command.

  Examples:

    Publish project (prompt for provider):  quarto publish
    Publish document (prompt for provider): quarto publish document.qmd
    Publish project to Netlify:             quarto publish netlify
    Publish with explicit target:           quarto publish netlify --id DA36416-F950-4647-815C-01A24233E294
    Publish project to GitHub Pages:        quarto publish gh-pages
    Publish project to Posit Connect:       quarto publish connect
    Publish with explicit credentials:      quarto publish connect --server example.com --token 01A24233E294
    Publish without confirmation prompt:    quarto publish --no-prompt
    Publish without rendering:              quarto publish --no-render
    Publish without opening browser:        quarto publish --no-browser
    Manage/remove publishing accounts:      quarto publish accounts