{"id":18339498,"url":"https://github.com/asciidoctor/gitbucket-asciidoctor-plugin","last_synced_at":"2025-04-06T05:32:06.915Z","repository":{"id":66216549,"uuid":"43749288","full_name":"asciidoctor/gitbucket-asciidoctor-plugin","owner":"asciidoctor","description":"A GitBucket plug-in that provided AsciiDoc rendering capabilities","archived":false,"fork":false,"pushed_at":"2024-01-05T10:21:43.000Z","size":47,"stargazers_count":19,"open_issues_count":2,"forks_count":11,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-10-30T00:00:42.304Z","etag":null,"topics":["asciidoc","asciidoctor","git","gitbucket","markup","plugin","rendering","scala"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asciidoctor.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"lefou"}},"created_at":"2015-10-06T12:31:14.000Z","updated_at":"2024-10-01T15:24:52.000Z","dependencies_parsed_at":"2023-12-26T09:01:20.688Z","dependency_job_id":"53c33836-66a2-44df-adc7-5cd9fb0f8e7e","html_url":"https://github.com/asciidoctor/gitbucket-asciidoctor-plugin","commit_stats":{"total_commits":61,"total_committers":9,"mean_commits":6.777777777777778,"dds":"0.19672131147540983","last_synced_commit":"73f6dd3bfd49bf15851b7f724f569c4247be9004"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asciidoctor%2Fgitbucket-asciidoctor-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asciidoctor%2Fgitbucket-asciidoctor-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asciidoctor%2Fgitbucket-asciidoctor-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asciidoctor%2Fgitbucket-asciidoctor-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asciidoctor","download_url":"https://codeload.github.com/asciidoctor/gitbucket-asciidoctor-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246759500,"owners_count":20829109,"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","git","gitbucket","markup","plugin","rendering","scala"],"created_at":"2024-11-05T20:18:11.267Z","updated_at":"2025-04-06T05:32:06.535Z","avatar_url":"https://github.com/asciidoctor.png","language":"Scala","funding_links":["https://github.com/sponsors/lefou"],"categories":[],"sub_categories":[],"readme":"= gitbucket-asciidoctor-plugin\n:plugin-version: 1.1.0\n:scala-version: 2.13\n:gitbucket-bincompat-version: 4.32.0\n:link-github: https://github.com/asciidoctor/gitbucket-asciidoctor-plugin\n\n\nimage:{link-github}/actions/workflows/build.yml/badge.svg[\"Build Status (build.yml)\", link=\"{link-github}/actions/workflows/build.yml\"]\nimage:https://badges.gitter.im/asciidoctor/gitbucket-asciidoctor-plugin.svg[\"Gitter Chat\", link=\"https://gitter.im/asciidoctor/gitbucket-asciidoctor-plugin\"]\n\nA https://github.com/gitbucket/gitbucket[GitBucket] plug-in that provides AsciiDoc rendering capabilities.\nAll `.adoc` (and also the deprecated `.asciidoc` and `.ad` suffix) files will be automatically rendered as AsciiDoc, supporting most features of the http://asciidoctor.org/[Asciidoctor project], including rendering of a table of contents.\n\n== Download\n\nYou can download a precompiled version from the {link-github}/releases[Release page].\n\n\n== Build from source\n\n.With sbt\n----\nsbt assembly\n----\n\n.Or with GNU Make\n----\nmake build\n----\n\nYou will find the packages plugin under `target/scala_2.13/gitbucket-asciidoctor-plugin-gitbucket_{gitbucket-bincompat-version}-{plugin-version}.jar`\n\n\n== Installation\n\nDownload `gitbucket-asciidoctor-plugin-gitbucket_{gitbucket-bincompat-version}-{plugin-version}.jar`\n or build the assembly package JAR file from source and copy it into `GITBUCKET_HOME/plugins`.\n If you have older versions of this plugin in this directory, you must delete them.\n Then restart GitBucket.\n That's it.\n\n== Local Test Server\n\nYou can start a local GitBucket instance with this plugin already installed by running:\n\n----\nmake localServer\n----\n\nPoint your browser to http://localhost:8080. The administrator login is root/root.\n\n\n== Configuration\n\n===  Asciidoctor builtin attributes\n\nYou can tweak the asciidoctor rendering engine by customizing the\nhttp://asciidoctor.org/docs/user-manual/#builtin-attributes[builtin attributes]. Simple edit the properties file at `GITBUCKET_HOME/asciidoctor.properties`.\n\n.Example: Set `toc` attribute in the `GITBUCKET_HOME/asciidoctor.properties` file\n[source,properties]\n----\ntoc=preamble\n----\n\n\n== License\n\nThis plugin is published under the Apache License, version 2.0.\n\n== ChangeLog\n\n=== gitbucket-asciidoctor-plugin 1.1.0 - 2019-11-19\n\n* Support fot GitBucket 4.32.0\n* Updated dependencies\n* Added include support (for files in the same repository)\n\nSee https://github.com/asciidoctor/gitbucket-asciidoctor-plugin/milestone/6?closed=1[list of closed issues and pull requests].\n\n=== gitbucket-asciidoctor-plugin 1.0.2 - 2017-03-08\n\n* Added support to provide attributes to the asciidoctor engine via properties file in gitbucket directory.\n\n=== gitbucket-asciidoctor-plugin 1.0.1 - 2016-06-01\n\n* Post-process `src` attribute of generated `\u003cimg\u003e` tags to point to raw image resource.\n\n=== gitbucket-asciidoctor-plugin 1.0.0 - 2016-05-03\n\n* Set the `outfilesuffix` attribute to `.adoc` to properly support xref's.\n* Introduced new attribute `gitbucket-branch` which contains the current selected git branch (or hash).\n* Requires GitBucket 4.0 or newer.\n\n=== gitbucket-asciidoctor-plugin 0.1.1 - 2016-02-02\n\n* Updated some dependency versions.\n* Set the attributes `env=gitbucket` and `env-gitbucket=true` so that rendered pages can apply environment specific logic.\n\n=== gitbucket-asciidoctor-plugin 0.1.0 - 2015-10-06\n\n* Initial release\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasciidoctor%2Fgitbucket-asciidoctor-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasciidoctor%2Fgitbucket-asciidoctor-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasciidoctor%2Fgitbucket-asciidoctor-plugin/lists"}