Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dev command to output help page in markdown format #1464

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Dev command to output help page in markdown format #1464

wants to merge 7 commits into from

Commits on Sep 23, 2023

  1. Support for markdown output in help messages 

    This functionality can be used to provide on-line versions of the help
messages for alire.ada.dev.

The help is generated in a single markdown page with appropiate
section titles, so it can have a table of contents.
    @mgrojo
    mgrojo committed Sep 23, 2023
    Configuration menu
    Copy the full SHA
    c47044a View commit details
    Browse the repository at this point in the history

Commits on Oct 14, 2023

  1. Improve markdown output (specially for Jekyll) 

    * Use `Formatter.Terminal` for command lines and switches not passed
  through `Hightlight_Switches`
* Avoid any <placeholder> which is not quoted as code
* Use consistent formatting for lists with "*" and not "-"
* Use indentation as a way to get preformat in appropriate cases
    @mgrojo
    mgrojo committed Oct 14, 2023
    Configuration menu
    Copy the full SHA
    06006b4 View commit details
    Browse the repository at this point in the history

  2. Merge remote-tracking branch 'origin/master' into feat/markdown-help 

    # Conflicts:
#	deps/clic
#	src/alr/alr-commands.ads
    @mgrojo
    mgrojo committed Oct 14, 2023
    Configuration menu
    Copy the full SHA
    1f1bb14 View commit details
    Browse the repository at this point in the history

  3. Avoid indentation in lists to make it work with Jekyll

    @mgrojo
    mgrojo committed Oct 14, 2023
    Configuration menu
    Copy the full SHA
    4f86e23 View commit details
    Browse the repository at this point in the history

  4. Fix pandoc output 

    Add a new line before lists

* It can be read better in the terminal
* It make the list work with `pandoc`

Add new CLIC commit also for `pandoc`.
    @mgrojo
    mgrojo committed Oct 14, 2023
    Configuration menu
    Copy the full SHA
    cbd419d View commit details
    Browse the repository at this point in the history

  5. Add CLIC fix for lists of options

    @mgrojo
    mgrojo committed Oct 14, 2023
    Configuration menu
    Copy the full SHA
    2fc647c View commit details
    Browse the repository at this point in the history

Commits on Oct 15, 2023

  1. Fix test due to line of call Trace.Debug call being greater than 99 

    When the line has three digits, the space is not present.

Example:

[Alr.Commands.Dev.Execute] (alr-commands-dev.adb:32 ) debug: In dev --filter

versus

[Alr.Commands.Dev.Execute] (alr-commands-dev.adb:100) debug: In dev --filter
    @mgrojo
    mgrojo committed Oct 15, 2023
    Configuration menu
    Copy the full SHA
    dd60348 View commit details
    Browse the repository at this point in the history