srsudar / eg

Useful examples at the command line.
MIT License
1.8k stars 98 forks source link

Add Command Line Interface Pages project support #97

Closed EmilyGraceSeville7cf closed 1 year ago

EmilyGraceSeville7cf commented 1 year ago

Main project page

Here is the current syntax description and a repo with pages.

Render is available here.

image

Pages for other CLIP project tools will be added later. Accepting this PR will help my project gain more popularity, thanks for understanding.

Important

This project goal is to replace TlDr project completely. CLIP project already has better client in terms of feature amount compared to TlDr official one and third party clients. To be specific: it provides more expressive and clear syntax for writing pages, color theme support. Even TlDr maintainers help me to develop it I think their main goal is to make TlDr project better and not mine, so I expect the most of the help from non-TlDr contributors.

EmilyGraceSeville7cf commented 1 year ago

@srsudar, can u review this PR?

srsudar commented 1 year ago

Sorry for the delay, thanks for the ping. A few points:

  1. Can you add two spaces after each example? Check out the find example for the syntax I copy:

https://raw.githubusercontent.com/srsudar/eg/master/eg/examples/find.md

I outline the requirements I'm working with here. Not sure I'd choose these again, but I'm sticking with them for now:

https://github.com/srsudar/eg#formatting

  1. Can you also add a # Basic Usage section like is in find? That is something I'd like to keep across all pages.

  2. The examples in the first section you should be able to run directly. These are all examples in the first section, and I don't think you can run them directly? Is the ... something you pass directly to the shell? I don't think it is but I'm not positive...

Something like this:

render specific local pages

    clip-view path/to/page1.clip path/to/page2.clip ..

should be more like:

render the local pages page1.clip and page2.clip

    clip-view path/to/page1.clip path/to/page2.clip

Same here, this shouldn't show the available options, this should choose one:

render page_name1 and page_name2 using the tldr-colorful renderer

    clip-view --render tldr-colorful page_name1 page_name2

All the examples in the first section should follow that syntax.

EmilyGraceSeville7cf commented 1 year ago

Thanks, I will fix these issues soon. 😁

EmilyGraceSeville7cf commented 1 year ago

@srsudar, problems fixed. πŸ˜„

EmilyGraceSeville7cf commented 1 year ago

@srsudar, any updates?

srsudar commented 1 year ago

@srsudar, any updates?

Almost there

srsudar commented 1 year ago

Nice, added a couple new lines and merged. Will go out in the next version.

EmilyGraceSeville7cf commented 1 year ago

Thanks! ☺️