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(snippets): markdown doc sections #127

Merged
merged 3 commits into from
May 16, 2023

Conversation

EmilyGraceSeville7cf
Copy link
Contributor

Snippets to quickly create docs for functions. Ideas for warnings and infos came after reading this post.

@fdncred
Copy link
Collaborator

fdncred commented May 16, 2023

sure. i don't think we can interpret the markdown but it's good. maybe vscode interprets it?

@fdncred fdncred merged commit 49e9ded into nushell:main May 16, 2023
@EmilyGraceSeville7cf
Copy link
Contributor Author

EmilyGraceSeville7cf commented May 16, 2023

maybe vscode interprets it?

It looks like it does. But I don't like it works out of the box. Some headers are too big, like # # Examples. Maybe it's intended but, btw. I mean it looks ugly to have too big first level headers in docs. ;)

@fdncred
Copy link
Collaborator

fdncred commented May 16, 2023

You may have to look at the hover code in the ide.rs file in nushell to understand what's going on.

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.

None yet

2 participants