{"id":16897395,"url":"https://github.com/robwin/asciidocular","last_synced_at":"2025-04-11T13:43:47.707Z","repository":{"id":83193283,"uuid":"43056603","full_name":"RobWin/asciidocular","owner":"RobWin","description":"Mobile first HTML5 web app for your project documentation written in AsciiDoc","archived":false,"fork":false,"pushed_at":"2015-10-04T11:12:40.000Z","size":1793,"stargazers_count":20,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-25T10:01:40.422Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","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/RobWin.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}},"created_at":"2015-09-24T09:11:52.000Z","updated_at":"2021-10-30T19:59:50.000Z","dependencies_parsed_at":"2023-03-07T09:15:16.645Z","dependency_job_id":null,"html_url":"https://github.com/RobWin/asciidocular","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobWin%2Fasciidocular","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobWin%2Fasciidocular/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobWin%2Fasciidocular/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RobWin%2Fasciidocular/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RobWin","download_url":"https://codeload.github.com/RobWin/asciidocular/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248410877,"owners_count":21098789,"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":[],"created_at":"2024-10-13T17:36:49.965Z","updated_at":"2025-04-11T13:43:47.683Z","avatar_url":"https://github.com/RobWin.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"= Asciidocular\n:icons: font\n:hardbreaks:\n\nimage:https://travis-ci.org/RobWin/asciidocular.svg?branch=master[\"Build Status\", link=\"https://travis-ci.org/RobWin/asciidocular\"]\n\nNOTE: Currently highly under development.\n\nAsciidocular is a small AngularJS web app that loads http://asciidoctor.org/[AsciiDoctor] files via Ajax and renders them as a full web site. Asciidocular uses https://github.com/asciidoctor/asciidoctor.js[asciidoctor.js] to convert the AsciiDoc files into HTML.\n\nAsciidocular can be used to create a documentation site of your project or API. For example, you could use Asciidocular together with https://github.com/Swagger2Markup/swagger2markup[Swagger2Markup] to create a documentation site of your http://swagger.io[Swagger] API.\n\nSince AsciiDoc syntax is just plain text, you can write an AsciiDoc document using any text editor.\n\nAdvantages:\n\n* No build process and server-side tools needed to convert your AsciiDoc files into HTML\n* Responsive Bootswatch (Bootstrap) theme\n* Deployable via GitHub Pages\n* Just create AsciiDoc files and deploy!\n\nFeatures:\n\n* Supports highlight.js\n* Supports Font-Awesome\n\n== Demo\n\nhttp://robwin.github.io/asciidocular[Live Demo] deployed on GitHub Pages.\n\n== Usage Guide\n\n=== Building from source\n\nMake sure you have http://nodejs.org/[Node.js] installed.\n\n----\ngit clone https://github.com/RobWin/asciidocular.git\ncd asciidocular\nnpm run build\n----\n\n=== Create AsciiDoc files\n\nYou have to create an `index.adoc` file in the `docs` folder of the app.\n\n----\n= Asciidocular //\u003c1\u003e\nRobert Winkler\n:icons: font\n:icons: font\n:source-highlighter: highlightjs\n:hardbreaks:\n:idprefix:\n\nThis is a preamble. \u003c2\u003e\n\n[icon=\"fa fa-wrench\"] \u003c3\u003e\n== Chapter 1 //\u003c4\u003e\n\n=== Chapter 1.1 //\u003c5\u003e\n\nText in chapter 1.1\n\n* Item 1\n* Item 2\n\nNOTE: Asciidoctor supports font-based admonition icons, powered by Font Awesome!\n\n\\include::chapter2.adoc[] //\u003c6\u003e\n----\n\n\u003c1\u003e The document title is the title of the web site.\n\u003c2\u003e The preamble of the document is the content of the jumbotron.\n\u003c3\u003e You can add Font Awesome icons in front of top-level navigation items\n\u003c4\u003e Each level 1 section title is a top-level navigation item\n\u003c5\u003e Each level 2 section title is a sub navigation item of the parent section in the navigation bar.\n\u003c6\u003e You can include other AsciiDoc files into the `index.adoc` file.\n\n== Examples\n\n=== Asciidocular on Mobile Phone\nimage::images/asciidocular_mobile.png[]\n\n=== Asciidocular on Tablet\n==== Home\nimage::images/asciidocular_home.png[]\n\n==== Sections\nimage::images/asciidocular_section.png[]\n\n== Questions\nYou can ask questions about Asciidocular in https://gitter.im/Swagger2Markup/swagger2markup[Gitter].\n\n== Bugs\nIf you believe you have found a bug, please take a moment to search the existing issues. If no one else has reported the problem, please open a new issue that describes the problem in detail and, ideally, includes a test that reproduces it.\n\n== Enhancements\nIf you’d like an enhancement to be made to Asciidocular, pull requests are most welcome. The source code is on GitHub. You may want to search the existing issues and pull requests to see if the enhancement is already being worked on. You may also want to open a new issue to discuss a possible enhancement before work on it begins.\n\n== License\n\nCopyright 2015 Robert Winkler\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobwin%2Fasciidocular","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobwin%2Fasciidocular","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobwin%2Fasciidocular/lists"}