-
Notifications
You must be signed in to change notification settings - Fork 15
Open
Labels
Description
Consider adding some options for the users in the generate command?
I was wondering something like:
generate <path> Create API documentation
generate [options] <path>
Options:
-o, --output-path <path> The documentation markdown file output path
-u, --update <path> Update de documentation markdown file
-n, --no-install Skip npm install and create only the markdown file
-r, --request-buttons Add a request button for each request
-o, --output-path <path>
Now the default value of path isdocs/README.md. Would be nice if we could replace it for some other path.
2. -u, --update
Now if we have a docs folder or a package.json the process is stoped. As the api evolves is common the need to update the documentation. With this option set, the user could just update the existing markdown file.
-
-n, --no-install
It is great that the cli create all the doc website and npm install and so on. But in some cases it is more usefull to gerenerate just the plain markdown. -
-r, --request-buttons
Would be nice if in the generated website we could run the requests and easily test the apis.
todo:
hdg generate <options>
-
-o, --output-path <path> - update existing doc after response from the user
-
-n, --no-install -
-r, --request-buttons - tests