asciidoctor-html 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dfaf44dfed22e54fb5cac254f5dd1f18618cb40167bb2a506d2ba37ef381292
-  data.tar.gz: 5c9915bf539614fbcfdb8578009db076324c87e172a0871f4ee9383c68aed4f3
+  metadata.gz: ee8dae10172068a6042f6898e5f6b9d801a78a223437b0f82df70faffeb1f632
+  data.tar.gz: 3818250d4e4abc5a9a914c6fc2472b8ebc50aed01569134591b1f456fad5fa06
 SHA512:
-  metadata.gz: fe41726063320cc979c2ed2e117726ac8543dfde3337fd6fa9600a671c37bdcb25891b431147db21cf6d22121e9531f7d9fead0ddc246c430cce754acbbd52fd
-  data.tar.gz: b3c63eb1f916812247b58f9f397dd316149e2625e49fe23869137a7eb920cba0f0a34e966102984168f13695940b36657a4b41354069c62e176dda0c7358a0e9
+  metadata.gz: b582323d188aefb260a9fa2479c61bcb4ee207b333117a79c020c500547b5646f49d79bbaf97088d2c73e2906120245596bec4d21b7d0790fdbffe2005a41bc1
+  data.tar.gz: 70c63a302dce0d3ec6c0595af58e91952f0a48e6ff1b44d70979e3a9314dc18b6a57f55f4cd98ecee5d9a94e2cf5ed5209e8629c67ecaf522c475f5bc5251b51

data/.rubocop.yml

@@ -3,10 +3,10 @@ AllCops:
   NewCops: enable
 
 Metrics/AbcSize:
-  Max: 40
+  Max: 45
 
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 20
 
 Metrics/PerceivedComplexity:
   Max: 20
@@ -15,7 +15,7 @@ Metrics/BlockNesting:
   Max: 5
 
 Metrics/MethodLength:
-  Max: 30
+  Max: 35
 
 Metrics/ClassLength:
   Max: 200

data/CHANGELOG.md

@@ -9,3 +9,7 @@
 - Add custom olist conversion.
 - Automatic processing of reftexts based on block numbering scheme.
 - Automatic processing of anchor reftexts based on list item labels.
+
+## [0.1.2] - 2025-06-29
+
+- Allow for override reftext in list item anchor.

data/README.md

@@ -1,10 +1,8 @@
 [![Build](https://github.com/ravirajani/asciidoctor-html/actions/workflows/main.yml/badge.svg)](https://github.com/ravirajani/asciidoctor-html/actions/workflows/main.yml)
 
-# Asciidoctor::Html
+# asciidoctor-html
 
-**The code in this repo is being actively developed and currently has limited functionality.**
-
-When complete, this gem will provide an alternative HTML converter for [Asciidoctor](https://github.com/asciidoctor/asciidoctor) as well as Jekyll-based book generator.
+**The code in this repo is being actively developed. Use at your own risk.**
 
 ## Installation
 
@@ -19,21 +17,40 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ```bash
 gem install asciidoctor-html
 ```
+## Configuration
+
+See the documentation's [config.yml](docs/asciidoc/config.yml) for an example of a configuration file.
+In a typical scenario, you would put your configuration file in the same directory as your AsciiDoc
+sources.
 
-## Usage
+## Basic Usage
 
-```ruby
-require "asciidoctor"
-require "asciidoctor/html"
+Assuming your config file is in the same directory as your AsciiDoc sources, execute:
 
-Asciidoctor.convert_file "mydoc.adoc"
+```shell
+cd <ASCIIDOC_SOURCES_DIR>
+adoctohtml [--watch]
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bundle exec rake` to run the tests. You can also run `bin/cli` to test the CLI after making changes.
+
+Run `jekyll serve --livereload` inside the `docs/html` directory to preview your changes after running `bundle exec rake`.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `asciidoctor-html.gemspec`,
+and then run
+
+```shell
+bundle exec rake stylesheet
+bundle exec rake release
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+The first line runs the tests and builds the stylesheet `assets/css/styles.css`.
+The second line creates a git tag for the version, pushes git commits and the created tag,
+and pushes the `.gem` file to [rubygems.org](https://rubygems.org).
 
 
 ## License

data/Rakefile

@@ -1,22 +1,31 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "jekyll"
 require "minitest/test_task"
+require "rubocop/rake_task"
+require "jekyll"
+require "fileutils"
+require_relative "lib/asciidoctor/html"
 
-Minitest::TestTask.create
+JEKYLL_SITEDIR = "#{__dir__}/_site".freeze
+JEKYLL_CSSDIR = "#{JEKYLL_SITEDIR}/assets/css".freeze
 
-require "rubocop/rake_task"
+Minitest::TestTask.create
 
 RuboCop::RakeTask.new
 
-task build: %i[test rubocop] do
+task jekyll: %i[test rubocop] do
   config = Jekyll.configuration({
-                                  source: "./docs",
-                                  destination: "./_site"
+                                  source: "#{__dir__}/docs/html",
+                                  destination: JEKYLL_SITEDIR
                                 })
   site = Jekyll::Site.new(config)
   Jekyll::Commands::Build.build site, config
 end
 
+task stylesheet: %i[jekyll] do
+  FileUtils.mkdir_p Asciidoctor::Html::CSS_PATH, verbose: true
+  FileUtils.cp_r JEKYLL_CSSDIR, Asciidoctor::Html::ASSETS_PATH, verbose: true
+end
+
 task default: %i[test rubocop]