Giter Club home page Giter Club logo

asciidoctor-readthedocs-theme's Introduction

asciidoctor html readthedocs theme

This is an early draft trying to bring a more modern look to the readthedocs theme included in the asciidoctor gem.

Note
 This style is still work in progress and not every element has been finalized yet. Refer to the Sample Article file to judge for yourself.
asciidoctor readthedocs screenshot admonition
Figure 1. Screenshot of current admonition.
asciidoctor readthedocs screenshot lists
Figure 2. Screenshot of current lists.

How to use

Copy the css file

Simply copy the readthedocs.css file to your projects root folder and run asciidoctor as follows:

asciidoctor -a stylesdir="$(pwd)" -a sytlesheet=readthedocs.css *.adoc

As a git submodule

Add the style as git submodule into your project.

git submodule add \
  https://github.com/uroesch/asciidoctor-readthedocs-theme \
  readthedocs

The run asciidoctor as shown below.

asciidoctor \
  -a stylesdir="$(pwd)/readthedocs" \
  -a sytlesheet=readthedocs.css \
  *.adoc

Build from scratch

Prerequisites

  • ruby

  • rake

  • docker

Build

Simply type rake and the command will download a docker container for the build. And create the readthedocs.css file.

rake

Create test document

The syntax.adoc from the asciidoctor distribution is included use rake to create the html file. This yields the file samples/article.html.

rake test

Todo

  • ✓ Table of Contents

  • ❏ Admonition

    • ✓ Admonition colors and style.

    • ❏ Admonition title overrides.

    • ✓ Simple one line admonitions.

    • ❏ Rich content admonitions.

  • ✓ Lists

    • ✓ Unordered Lists

    • ✓ Ordered Lists

      • ✓ Alpha numeric

      • ✓ Roman numerals

    • ✓ Checklists

  • ✓ Links

    • ✓ Link symbol in section titles (anchor)

    • ✓ Adjust link and text-decoration.

  • ❏ Quotes

  • ❏ Tables

    • ❏ Table border style

    • ❏ Table header style

    • ✓ Code inside tables

    • ✓ Code inside tables

  • ❏ Cleanup

    • ❏ Remove duplication.

  • ❏ Footer

Regressions

  • ❏ Tables

    • ❏ Verses inside tables (v| prefix) do not render correctly.

    • ❏ Stripes don’t seem to work.

asciidoctor-readthedocs-theme's People

Contributors

github-actions[bot] avatar uroesch avatar

Stargazers

avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.