<commit_before>= {project-name}: A _native_ EPUB3 converter for AsciiDoc
<NAME> <https://github.com/mojavelinux[@mojavelinux]>; <NAME> <https://github.com/graphitefriction[@graphitefriction]>
// Settings:
:experimental:
:idprefix:
:idseparator: -
:imagesdir: data/samples/images
ifdef::env-github,env-browser[]
:toc: preamble
:toclevels: 1
endif::[]
ifdef::env-github[]
:status:
:!toc-title:
:caution-caption: :fire:
:important-caption: :exclamation:
:note-caption: :paperclip:
:tip-caption: :bulb:
:warning-caption: :warning:
endif::[]
ifndef::env-github[]
:icons: font
endif::[]
// Aliases:
:project-name: Asciidoctor EPUB3
:project-handle: asciidoctor-epub3
// URIs:
:uri-project: https://github.com/asciidoctor/{project-handle}
:uri-gem: http://rubygems.org/gems/asciidoctor-epub3
:uri-repo: {uri-project}
:uri-issues: {uri-repo}/issues
:uri-ci: {uri-repo}/actions?query=branch%3Amaster
:uri-discuss: http://discuss.asciidoctor.org
:uri-rvm: https://rvm.io
:uri-asciidoctor: http://asciidoctor.org
:uri-idpf: http://www.idpf.org/
:uri-epub: http://www.idpf.org/epub/31/spec/epub-spec.html
:uri-epubcheck: https://github.com/idpf/epubcheck
:uri-kindlegen: http://www.amazon.com/gp/feature.html?docId=1000765211
:uri-kf8: http://www.amazon.com/gp/feature.html?docId=1000729511
:uri-send-to-kindle: https://www.amazon.com/gp/sendtokindle/
:uri-metadata-elem: http://www.idpf.org/epub/30/spec/epub30-publications.html#sec-metadata-elem
:uri-dc: http://dublincore.org/documents/2004/12/20/dces
:uri-github-guides: https://guides.github.com
:uri-github-guides-fork: https://github.com/opendevise/github-guides-asciidoc
:uri-asciidoctor-i18n: http://asciidoctor.org/docs/user-manual/#builtin-attributes-i18n
:uri-epubreadingsystem: http://www.idpf.org/epub/301/spec/epub-contentdocs.html#app-epubReadingSystem
:uri-android-sdk: http://developer.android.com/sdk/index.html

ifdef::status[]
image:https://img.shields.io/gem/v/asciidoctor-epub3.svg[Latest Release,link={uri-gem}]
image:{uri-repo}/workflows/CI/badge.svg?branch=master[GitHub Actions,link={uri-ci}]
endif::[]

{project-name} is a set of Asciidoctor extensions for converting AsciiDoc documents directly to the EPUB3 and KF8/MOBI e-book formats.

== Introduction

{project-name} is not merely a converter from AsciiDoc to EPUB3 and KF8/MOBI.
Rather, it's a tool for creating highly aesthetic, professional, _easy-to-read_ e-books.
Let's face it, many of the technical e-books out there--especially those produced from software documentation--are *_hideous_*.
{project-name} is on a mission to disrupt the status quo.

ifdef::env-github[]
.An excerpt from an e-book produced by {project-name} shown in Day, Night and Sepia mode.
image::screenshots/text.png[]<commit_msg>Switch links in README to HTTPS wherever possible<commit_after>= {project-name}: A _native_ EPUB3 converter for AsciiDoc
<NAME> <https://github.com/mojavelinux[@mojavelinux]>; <NAME> <https://github.com/graphitefriction[@graphitefriction]>
// Settings:
:experimental:
:idprefix:
:idseparator: -
:imagesdir: data/samples/images
ifdef::env-github,env-browser[]
:toc: preamble
:toclevels: 1
endif::[]
ifdef::env-github[]
:status:
:!toc-title:
:caution-caption: :fire:
:important-caption: :exclamation:
:note-caption: :paperclip:
:tip-caption: :bulb:
:warning-caption: :warning:
endif::[]
ifndef::env-github[]
:icons: font
endif::[]
// Aliases:
:project-name: Asciidoctor EPUB3
:project-handle: asciidoctor-epub3
// URIs:
:uri-project: https://github.com/asciidoctor/{project-handle}
:uri-gem: https://rubygems.org/gems/asciidoctor-epub3
:uri-repo: {uri-project}
:uri-issues: {uri-repo}/issues
:uri-ci: {uri-repo}/actions?query=branch%3Amaster
:uri-discuss: https://discuss.asciidoctor.org/
:uri-rvm: https://rvm.io
:uri-asciidoctor: https://asciidoctor.org/
:uri-idpf: http://www.idpf.org/
:uri-epub: http://www.idpf.org/epub/31/spec/epub-spec.html
:uri-epubcheck: https://github.com/w3c/epubcheck
:uri-kindlegen: https://www.amazon.com/gp/feature.html?docId=1000765211
:uri-kf8: http://www.amazon.com/gp/feature.html?docId=1000729511
:uri-send-to-kindle: https://www.amazon.com/gp/sendtokindle/
:uri-metadata-elem: http://www.idpf.org/epub/30/spec/epub30-publications.html#sec-metadata-elem
:uri-dc: https://www.dublincore.org/specifications/dublin-core/dces/2004-12-20/
:uri-github-guides: https://guides.github.com
:uri-github-guides-fork: https://github.com/opendevise/github-guides-asciidoc
:uri-asciidoctor-i18n: https://asciidoctor.org/docs/user-manual/#builtin-attributes-i18n
:uri-epubreadingsystem: http://www.idpf.org/epub/301/spec/epub-contentdocs.html#app-epubReadingSystem
:uri-android-sdk: https://developer.android.com/sdk/index.html

ifdef::status[]
image:https://img.shields.io/gem/v/asciidoctor-epub3.svg[Latest Release,link={uri-gem}]
image:{uri-repo}/workflows/CI/badge.svg?branch=master[GitHub Actions,link={uri-ci}]
endif::[]

{project-name} is a set of Asciidoctor extensions for converting AsciiDoc documents directly to the EPUB3 and KF8/MOBI e-book formats.

== Introduction

{project-name} is not merely a converter from AsciiDoc to EPUB3 and KF8/MOBI.
Rather, it's a tool for creating highly aesthetic, professional, _easy-to-read_ e-books.
Let's face it, many of the technical e-books out there--especially those produced from software documentation--are *_hideous_*.
{project-name} is on a mission to disrupt the status quo.

ifdef::env-github[]
.An excerpt from an e-book produced by {project-name} shown in Day, Night and Sepia mode.
image::screenshots/text.png[]
{'fraction_non_alphanumeric': 0.16594202898550725, 'fraction_numerical': 0.019384057971014494, 'mean_word_length': 5.464871194379391, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 25, 'lorem ipsum': 0, 'www.': 15, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '443828', 'n_tokens_mistral': 2132, 'n_tokens_neox': 2033, 'n_words': 372}