-
-
Notifications
You must be signed in to change notification settings - Fork 7
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
Include Code Snippets for Package Installation #57
Comments
@Daeraxa Just was thinking about this one. Since we have a rather simple layout of the metadata of the package at the top of a page, then the actual readme content below, where exactly do we want to put installation instructions. Do we want to go the route of NPMjs and put them on a new sidebar, or would we rather include them as new section underneath the package metadata details? Or somewhere else that I haven't thought of |
I've come up with two relatively simple ideas of how to implement it. I do think that just putting them with the rest of the metadata makes sense. The two examples (forgive the mix and match of themes, this wasn't done "properly", just with some html editing and paint. There is a question as to if we want to extend the functionality (not necessarily a final design) to the small package cards as well (the ones on the list and featured pages). |
Have you checked for existing feature requests?
Summary
As suggested by @Daeraxa including code snippets for how to install packages would help display the methods of installation and tie things in closer to the actual Pulsar application.
I.E.
pulsar -p install atom-clock
orppm install atom-clock
What benefits does this feature provide?
Similar to NPM makes things easier to those working on the CLI to use the resources found on the web
Any alternatives?
Make people figure it out on their own I suppose
Other examples:
No response
The text was updated successfully, but these errors were encountered: