Adding basic doc generation functionality #60
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change adds basic documentation generation functionality to nupm.
Using the current package's code, or paths to other modules it will generate a directory of markdown files based on the internal metadata about the modules and commands (data from
scope
).The majority of the code is shamelessly stolen from @amtoine's nu-git-manager toolkit script and modified.
There's a lot of basic functionality missing that I'd like to add like generating HTML and documenting plugins, but this is a good first step.
I also added the generated documentation for nupm itself because it seemed appropriate.