{"id":20218231,"url":"https://github.com/numberfour/asciispec","last_synced_at":"2026-05-27T23:32:08.961Z","repository":{"id":138345275,"uuid":"77920676","full_name":"NumberFour/asciispec","owner":"NumberFour","description":"asciispec","archived":false,"fork":false,"pushed_at":"2019-01-23T10:32:30.000Z","size":30463,"stargazers_count":1,"open_issues_count":12,"forks_count":2,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-03T11:35:46.847Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://numberfour.github.io/asciispec","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NumberFour.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-03T13:44:03.000Z","updated_at":"2022-02-14T09:46:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"e69816b2-4dc5-4744-a79a-047ce333b26c","html_url":"https://github.com/NumberFour/asciispec","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/NumberFour/asciispec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumberFour%2Fasciispec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumberFour%2Fasciispec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumberFour%2Fasciispec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumberFour%2Fasciispec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NumberFour","download_url":"https://codeload.github.com/NumberFour/asciispec/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumberFour%2Fasciispec/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33588345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-27T02:00:06.184Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-14T06:37:39.473Z","updated_at":"2026-05-27T23:32:08.956Z","avatar_url":"https://github.com/NumberFour.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"ifdef::env-github,env-browser[:outfilesuffix: .adoc]\n\nA documentation toolchain based on http://asciidoctor.org/[AsciiDoctor]. It implements custom processors for technical writing, organizing documentation and task management.\n\n== Features\n*\u003c\u003cdocs/custom-processors/definition-block#,[def] - Definition Block\u003e\u003e*: Add definitions with custom formatting. +\n*\u003c\u003cdocs/custom-processors/extended-include-macro#,include::{}[ ] - Include (extended)\u003e\u003e*: Includes files using special variables. +\n*\u003c\u003cdocs/custom-processors/inline-cwiki-macro#,cwiki:[ ] - Inline Cwiki\u003e\u003e*: Inserting links to Confluence Wiki pages. +\n*\u003c\u003cdocs/custom-processors/inline-task-macro#,task:[ ] - Inline Task\u003e\u003e*: Insert links to Jira and GitHub. +\n*\u003c\u003cdocs/custom-processors/inline-bibtex-macro#,cite:[ ] - Inline BibTeX\u003e\u003e*: Inserting citations from a BibTeX file. +\n*\u003c\u003cdocs/custom-processors/inline-srclnk-macro#,srclnk:[ ] - Inline Source Link\u003e\u003e*: Inserting links to source files on GitHub. +\n*\u003c\u003cdocs/custom-processors/inline-math-macro#,math:[ ] - Inline Math\u003e\u003e*: Inserting math expressions. +\n*\u003c\u003cdocs/custom-processors/math-block#,[math] - Math Block\u003e\u003e*: Add long math formulae. +\n*\u003c\u003cdocs/custom-processors/requirements-block#,[req] - Requirement Block\u003e\u003e*: Add requirements with custom formatting. +\n*\u003c\u003cdocs/custom-processors/todo-block#,[TODO] - Todo Block\u003e\u003e*: Add a custom TODO admonition block. +\n*\u003c\u003cdocs/custom-processors/inline-callout-macro#,call:[ ] - Inline Callout Macro\u003e\u003e*: Arbitrarily add numbered callouts. \n\n\n==  Prerequisites\n\n* http://maven.apache.org/[Apache Maven]\n* https://github.com/asciidoctor/asciidoctorj/tree/asciidoctorj-1.6.0[asciidoctorj-1.6.0]. There is no artifact publicly available at the moment. Please follow these steps:\n.. Checkout https://github.com/asciidoctor/asciidoctorj/tree/asciidoctorj-1.6.0[asciidoctorj-1.6.0]\n.. Navigate to the root of the asciidoctorj-1.6.0 project and run `./gradlew assemble`\n.. Install the dependency to your local maven repository by running\n\n[source,bash]\nmvn install:install-file -Dfile=./asciidoctorj-core/build/libs/asciidoctorj-1.6.0-SNAPSHOT.jar -DgroupId=org.asciidoctor -DartifactId=asciidoctorj -Dversion=1.6.0-SNAPSHOT -Dpackaging=jar\n\n* https://github.com/kduske-n4/snuggletex[snuggletex-1.2.3]. This is a custom fork of http://www2.ph.ed.ac.uk/snuggletex[SnuggleTex] that supports a few more LaTeX symbols in math expressions. Please follow these steps:\n.. Checkout https://github.com/kduske-n4/snuggletex[snuggletex-1.2.3] and switch to branch `enfore`.\n.. Navigate to the root of the snuggletex project and run `mvn package`\n.. Install the dependency to your local maven repository by running\n\n[source,bash]\nmvn install:install-file -Dfile=./snuggletex-core/target/snuggletex-core-1.2.2.jar -DgroupId=uk.ac.ed.ph.snuggletex -DartifactId=snuggletex-core -Dversion=1.2.3-SNAPSHOT -Dpackaging=jar\n\nOnce installed, remember to update the project dependencies within your IDE. In Eclipse you can do this by right clicking on the project -\u003e Maven -\u003e Update Project. That should resolve dependency related errors.\n\nTo import Asciispec into Eclipse, install the m2e plugin and use the project import wizard.\n\n== Build\n\nTo build the project, clone this repository, navigate to the project folder and run the following command (optionally add `-Dmaven.test.skip=true` to skip tests):\n\n[source,bash]\nmvn clean package\n\nAfter maven has successfully finished building the project, a zip file containing the asciispec tool will be available under `asciispec/target/asciispec-bin.zip`\n\n[.language-bash]\n== Installation\nAdd AsciiSpec to your shell profile with the path to the `asciispec/bin` directory on your system:\n\n`pass:[export PATH=$PATH:~/path/to/asciispec/bin/]`\n\nIf the AsciiSpec tool is found by your system, running AsciiSpec with the `-h` flag will print a help page:\n\n[source,bash]\nasciispec -h\n\n== Usage\n=== Convert to HTML\nGenerates a `sample.html` file in the current directory:\n\n[source,bash]\nasciispec sample.adoc\n\n=== Convert to DocBook:\nGenerates a `sample.xml` file in the current directory.\n\n[source,bash]\nasciispec -b docbook sample.adoc\n\nDocBook format can be further converter to *PDF* with https://github.com/NumberFour/asciidoctor-fopub[asciidoctor-fopub]. This fork of the fopub project contains some cosmetic changes.\n\n=== Help\nRunning `asciispec -h` will print the AsciiDoctor help page. +\nFor more options, see the http://asciidoctor.org/docs/user-manual/#cli-options[CLI Options] section of the AsciiDoctor user manual.\n\n== Documentation\n\n[horizontal]\nHTML Documentation:: *http://numberfour.github.io/asciispec*\nUserguide:: https://numberfour.github.io/asciispec/userguide.html[Userguide]: Introduction to AsciiDoc syntax and some basic AsciiSpec usage tips.\nOther:: *\u003c\u003cdocs/troubleshooting#,Troubleshooting\u003e\u003e*: Help for getting started and debugging installation errors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumberfour%2Fasciispec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnumberfour%2Fasciispec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumberfour%2Fasciispec/lists"}