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

Added in a man page for jsdoc #1846

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

Yash-Singh1
Copy link

@Yash-Singh1 Yash-Singh1 commented Aug 25, 2020

Table

Question Answer
Bugfix? No
New feature? Yes
Breaking change? No
Deprecations? No
Tests added? No
Fixed issues N/A
License Apache-2.0

Overview

Added in a man page for jsdoc.

List of Updates

Here is a list of updates

  • Edited package.json to include an entry called man (npm automatically installs man pages inside the man entry)
  • Created a file at jsdoc.1
  • Added in a man page at jsdoc.1 using txt2man on the --help output

Testing

To test the layout, run:

git clone https://github.com/Yash-Singh1/jsdoc.git
cd jsdoc
man ./jsdoc.1

To test the changes, run:

git clone https://github.com/Yash-Singh1/jsdoc.git
cd jsdoc
sudo npm -g uninstall jsdoc ; npm link

Run man jsdoc and the manual page should appear.
To go back to the normal environment:

sudo npm -g uninstall jsdoc ; npm install -g jsdoc

Note: The testing process will only work when the PR is open

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