The AsciiDoc sources and assets to build the main README and its HTML version:
../README.adoc— single-file "coalesced" AsciiDoc version, for GitHub previewing.../docs/index.html— HTML version, served on GHPages website.
Table of Contents
For maintainability, the README.adoc document in the root is built from multiple AsciiDoc source files, by preprocessing them via the asciidoc-coalescer.rb script. Working on one-file-per-section is easier than editing a single long document.
The AsciiDoc source file:
will be converted (via build.sh) to:
../README.adoc— single-file preprocessed ADoc, for preview on repository landing page.../docs/index.html— WWW version, served via GitHub pages.
build.sh— conversion script.preview.sh— create local HTML preview (ignored by Git).asciidoc-coalescer.rb— script to create a preprocessed AsciiDoc file.awesome-if.asciidoc— main AsciiDoc file of the awesome list, willinclude::other files at build time:*.adoc— each file a section of the awesome list.
The Awesome IF document is split in multiple *.adoc files, each file representing a single section (Level 1, or 2) in the final document — some large sections (e.g. Software) are split into multiple Level 2 sections, for practical reasons.
The individual *.adoc files are treated as standalone documents, complete with a document title (Level 0). Their heading levels are then adjusted at inclusion time via the leveloffset attribute in the include directive. This allows to edit them without having to worry about their effective Level in the final document(s). Also, in the future the website version of Awesome IF might be split into multiple HTML pages, if the document becomes too long.
NOTE — Currently, trying to convert the single sections ad standalone documents is likely to fail, due to missing cross references or custom attributes definitions. In the future this might be fixed by tweaking their contents so that they might be reused in a fully standalone manner, for it might be useful to allow other projects to reuse single sections of this project in other contexts too.
While editing locally, you might want to check the results via the following script:
The script will create a local HTML preview file named awesome-if.html (ignored by Git) by invoking Asciidoctor with all the required settings.
You'll need Asciidoctor (Ruby) to build the documents.
The AsciiDoc coalescer script was downloaded from the Asciidoctor Extensions Lab project (commit b617f44, 2019/08/31):
Released under MIT License:
The MIT License
Copyright (C) 2014-2016 The Asciidoctor Project
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
A selection of direct links to Asciidoctor topics relevant to working with the Awesome IF project: