version 1.1   Ruby 3   CC0   Travis CI Build Status   badge

A GitHub repository template for creating Asciidcotor powered Awesome Lists.

Created by Tristano Ajmone in August 2021.

About

Thanks to this GitHub repository template you’ll be able to quickly setup a new repository for your Awesome List leveraging the power of Asciidoctor (Ruby). The template provides you with all the scaffolding, repository settings and build scripts to get you going in a few a minutes.

Project Structure

  • /docs/ — GitHub Pages static website, served from docs folder, and images source folder (if any).

    • .nojekyll — enforces static website (disables Jekyll).

    • index.html — converted HTML document.

  • /docs_src/ — AsciiDoc sources.

    • *.adoc — sub-documents imported into index.asciidoc.

    • asciidoc-coalescer.rb — coalescer script to generate ../README.adoc as a single AsciiDoc file.

    • index.asciidoc — main source document.

    • preview.html — converted HTML preview document (untracked).

    • warn-editing.txt — a “don’t edit me” comment injected into output docs.

  • .editorconfig — EditorConfig settings for code styles consistency.

  • .gitattributes — ad hoc Git settings.

  • .gitignore — ad hoc Git settings.

  • .travis.yml — Travis CI configuration for testing build and code consistency.

  • git-hook-install.sh — install pre-commit Git hook to validate code styles consistency.

  • git-hook-remove.sh — uninstall pre-commit Git hook.

  • Rakefile — where all the build toolchain magic happens.

  • README.adoc — AsciiDoc sources coalesced into single README doc for GitHub previewing.

  • validate.sh — validates EditorConfig code styles consistency via EClint.

Building

This Awesome List template is powered via Rake.

To generate the local preview docs_src/preview.html (untracked):

rake

To build the website document and the coalesced README.adoc:

rake build

To clobber and rebuild all:

rake all

For more info:

rake -T

License

This repository template is released into the public domain via the CC0 1.0 Universal Public Domain Dedication.

The third party assets mentioned in the Credits section below retain their own Copyright and license status and are not affect by the CC0 1.0 license of this project.

Credits

This project uses the following third party assets.

AsciiDoc Coalescer

The AsciiDoc coalescer, Copyright © 2014-2019 The Asciidoctor Project, MIT License. Downloaded from the “Asciidoctor Extensions Lab” project (commit b617f44, 2019/08/31):

The MIT License

Copyright (C) 2014-2019 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.

ChangeLog

v1.1.0 — 2021-12-20

  • Adopt Rake for the build toolchain.

    • Delete old shell build files.

  • Generated local preview doc renamed to docs_src/preview.html.

v1.0.0 — 2021-08-09

Initial release.