{"action":"created","issue":{"url":"https://api.github.com/repos/zdharma/zshelldoc/issues/1","repository_url":"https://api.github.com/repos/zdharma/zshelldoc","labels_url":"https://api.github.com/repos/zdharma/zshelldoc/issues/1/labels{/name}","comments_url":"https://api.github.com/repos/zdharma/zshelldoc/issues/1/comments","events_url":"https://api.github.com/repos/zdharma/zshelldoc/issues/1/events","html_url":"https://github.com/zdharma/zshelldoc/issues/1","id":341876205,"node_id":"MDU6SXNzdWUzNDE4NzYyMDU=","number":1,"title":"Allow defining custom synopsis","user":{"login":"marcingrzejszczak","id":3297437,"node_id":"MDQ6VXNlcjMyOTc0Mzc=","avatar_url":"https://avatars0.githubusercontent.com/u/3297437?v=4","gravatar_id":"","url":"https://api.github.com/users/marcingrzejszczak","html_url":"https://github.com/marcingrzejszczak","followers_url":"https://api.github.com/users/marcingrzejszczak/followers","following_url":"https://api.github.com/users/marcingrzejszczak/following{/other_user}","gists_url":"https://api.github.com/users/marcingrzejszczak/gists{/gist_id}","starred_url":"https://api.github.com/users/marcingrzejszczak/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/marcingrzejszczak/subscriptions","organizations_url":"https://api.github.com/users/marcingrzejszczak/orgs","repos_url":"https://api.github.com/users/marcingrzejszczak/repos","events_url":"https://api.github.com/users/marcingrzejszczak/events{/privacy}","received_events_url":"https://api.github.com/users/marcingrzejszczak/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2018-07-17T11:20:19Z","updated_at":"2018-07-20T05:49:56Z","closed_at":null,"author_association":"NONE","body":"Currently by default (https://github.com/zdharma/zshelldoc/blob/master/src/zsd-to-adoc.main#L85) we get the `Documentation automatically generated with zshelldoc`. It would be great to provide an option to pass custom synopsis. That way we can provide some insight into each script.\r\n\r\nBTW this framework is awesome and we're using it in Spring Cloud Pipelines (https://github.com/spring-cloud/spring-cloud-pipelines/blob/master/common/src/main/bash/README.adoc)"},"comment":{"url":"https://api.github.com/repos/zdharma/zshelldoc/issues/comments/406495959","html_url":"https://github.com/zdharma/zshelldoc/issues/1#issuecomment-406495959","issue_url":"https://api.github.com/repos/zdharma/zshelldoc/issues/1","id":406495959,"node_id":"MDEyOklzc3VlQ29tbWVudDQwNjQ5NTk1OQ==","user":{"login":"psprint","id":6049288,"node_id":"MDQ6VXNlcjYwNDkyODg=","avatar_url":"https://avatars2.githubusercontent.com/u/6049288?v=4","gravatar_id":"","url":"https://api.github.com/users/psprint","html_url":"https://github.com/psprint","followers_url":"https://api.github.com/users/psprint/followers","following_url":"https://api.github.com/users/psprint/following{/other_user}","gists_url":"https://api.github.com/users/psprint/gists{/gist_id}","starred_url":"https://api.github.com/users/psprint/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/psprint/subscriptions","organizations_url":"https://api.github.com/users/psprint/orgs","repos_url":"https://api.github.com/users/psprint/repos","events_url":"https://api.github.com/users/psprint/events{/privacy}","received_events_url":"https://api.github.com/users/psprint/received_events","type":"User","site_admin":false},"created_at":"2018-07-20T05:49:56Z","updated_at":"2018-07-20T05:49:56Z","author_association":"COLLABORATOR","body":"It's a good idea, I've implemented it. It works like you requested:\r\n\r\n```\r\n# synopsis {{{\r\n# Hello world +\r\n# Second line\r\n# }}}\r\n```\r\n\r\nString \"synopsis\" is compared in case insensitive manner, the delimeters `{{{`, `}}}` can be customized with options `--blocka`, `--blockb`."}}
{"actor":{"display_login":"psprint"}}