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.

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

feat(help) Finished rendering and styled multiple help pages #58

Merged
merged 7 commits into from
Oct 16, 2023

Conversation

viega
Copy link
Contributor

@viega viega commented Oct 15, 2023

Issue

Closes #32

Description

We released without the renderer being finished, and so there were multiple display issues with displaying help content, particularly in tables. Also things like, if NO_COLOR is set, we don't just skip color, we skip any terminal code.

Now, the initial renderer has been finished, and lots of 'features' have been added, for instance, to allow us to have more flexibility in table layout.

There's a default chalk 'style' too, but it's set up to make it easy for us to enable others to configure their own style.

The renderer is 'good enough' now that we will have a very easy time moving to any sort of full-screen model instead of a scrolling model... which I do intend to do soon with the component system.

However, now that things seem pretty healthy, we do need to go back and adjust the docs to format properly. I've seen there are definitely some places where tweaks need to be made, for instance, if the doc is using markdown in a context where markdown doesn't get processed, etc.

Testing

Try chalk help or chalk help metadata and see that they're no longer utterly horrid.

@viega
Copy link
Contributor Author

viega commented Oct 16, 2023

The failing tests are only failing because of error message changes in Con4m and will be passing as soon as #47 is merged.

Copy link
Contributor

@MyNameIsMeerkat MyNameIsMeerkat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good to me

@viega viega merged commit 2336bf0 into main Oct 16, 2023
@viega viega deleted the jtv/newrender branch October 16, 2023 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Finish the basic functionality for document rendering
2 participants