{"id":13733836,"url":"https://github.com/clydeclements/AsciiDocQuickLook","last_synced_at":"2025-05-08T10:30:25.770Z","repository":{"id":217227063,"uuid":"106309566","full_name":"clydeclements/AsciiDocQuickLook","owner":"clydeclements","description":"A QuickLook plugin to preview AsciiDoc files.","archived":false,"fork":false,"pushed_at":"2022-11-27T15:02:06.000Z","size":97,"stargazers_count":28,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-09T12:43:24.932Z","etag":null,"topics":["asciidoc","asciidoctor","macos","quicklook","quicklook-plugin"],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clydeclements.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-10-09T16:46:24.000Z","updated_at":"2024-05-27T02:53:35.000Z","dependencies_parsed_at":"2024-01-15T06:04:24.774Z","dependency_job_id":null,"html_url":"https://github.com/clydeclements/AsciiDocQuickLook","commit_stats":null,"previous_names":["clydeclements/asciidocquicklook"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clydeclements%2FAsciiDocQuickLook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clydeclements%2FAsciiDocQuickLook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clydeclements%2FAsciiDocQuickLook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clydeclements%2FAsciiDocQuickLook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clydeclements","download_url":"https://codeload.github.com/clydeclements/AsciiDocQuickLook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224720748,"owners_count":17358476,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asciidoc","asciidoctor","macos","quicklook","quicklook-plugin"],"created_at":"2024-08-03T03:00:49.876Z","updated_at":"2024-11-15T02:31:50.516Z","avatar_url":"https://github.com/clydeclements.png","language":"C","readme":"= AsciiDoc Quick Look\n\n:url-releases: https://github.com/clydeclements/AsciiDocQuickLook/releases\n:url-what-is-asciidoc: http://asciidoctor.org/docs/what-is-asciidoc/\n:url-asciidoctor: http://asciidoctor.org/\n:url-terminating-processes: https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/Lifecycle.html#//apple_ref/doc/uid/10000172i-SW3-114794-BAJIBGGI\n:url-asciidoctorjs: http://asciidoctor.org/docs/install-and-use-asciidoctorjs\n:url-qlswift: https://github.com/lexrus/QLSwift\n\n\n== Introduction\n\nThis is a Quick Look plug-in for {url-what-is-asciidoc}[AsciiDoc] format files.\nIt renders a preview of an AsciiDoc file selected in the Finder by using\n{url-asciidoctor}[Asciidoctor].\n\n== Installation\n\n* By default this plug-in uses Asciidoctor to render the preview. Therefore,\nfirst install that program via your preferred method. For example, to install\nvia the system `gem` command, use:\n\n  sudo gem install asciidoctor\n\n* Download a zipped {url-releases}[binary] of this plug-in. Unzip and move\n`AsciiDoc.qlgenerator` into `/Library/QuickLook`. Note the plug-in will not\nwork if installed to a user directory `~/Library/QuickLook` due to restraints\nimposed by the sand-boxing of Quick Look plug-ins.\n\n* Lastly, open Terminal and run the command `qlmanage -r` to reset the Quick\nLook Server.\n\n== Customization\n\nThe preview of an AsciiDoc file is generated by converting it to HTML via\nAsciidoctor and displaying the resultant HTML. This process can be customized\nby setting a preference to override the converter:\n\n  defaults write ca.bluemist2.AsciiDocQuickLook AsciiDocConverter /path/to/my_converter\n\nThe last part of the above command must give the full path to an executable\nthat accepts one argument, the name of the AsciiDoc file to be previewed, and\nwrites the corresponding HTML format on standard output. For example, create\na shell script called `asciidoc_to_html` with content similar to the following:\n\n  #!/bin/bash\n  export PATH=/usr/local/bin:$PATH\n  asciidoctor -b html5 -a nofooter -a icons=font -o - \"$1\"\n\nEnsure the script is executable (use `chmod +x asciidoc_to_html`) and place it\nin your `~/bin` folder (create the folder if it does not exist). Lastly, set\nthe converter preference:\n\n  defaults write ca.bluemist2.AsciiDocQuickLook AsciiDocConverter ~/bin/asciidoc_to_html\n\n== To Do\n\n* A process should support sudden termination for the best user experience;\nsee {url-terminating-processes}[Terminating Processes]. This plug-in works by\nlaunching an Asciidoctor process. Could the handling of this process be\nimproved?\n\n* Consider using {url-asciidoctorjs}[asciidoctor.js] to generate previews.\nExamine {url-qlswift}[QLSwift] to see how it generates previews using\nJavaScript. This method would not require the Asciidoctor program to be\ninstalled (though it would require distribution of `asciidoctor.js`) and it\nwould not need to launch a separate process.\n\n== Release History\n\n* 1.0 (2017-11-06): Initial release\n\n== License\n\nCopyright (C) 2017 Clyde Clements\n\nThe AsciiDoc Quick Look plug-in is distributed under the MIT license. See the\nlink:LICENSE.txt[license] file for more information.\n","funding_links":[],"categories":["C","Plugins"],"sub_categories":["Using [HomeBrew Cask](http://caskroom.github.io/)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclydeclements%2FAsciiDocQuickLook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclydeclements%2FAsciiDocQuickLook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclydeclements%2FAsciiDocQuickLook/lists"}