Git Product home page Git Product logo

docsify-asciidoc's Introduction

Docsify AsciiDoc plugin

With docsify-asciidoc you can render AsciiDoc pages in Docsify.

This plugin leverage is a simple Docsify plugin based on the great work done in other projects:

You can choose the embedded Downdoc rendered (very small footprint) or use Asciidoctor as processor.

How to use it

Ensure you disable the default .md extension in Docsify:

    window.$docsify = {
        ext: ''
    }

With Asciidoctor

For a more complete feature set you can use Asciidoctor.js, and you need to import 2 libraries in your docsify index.html:

<!-- Asciidoctor -->
<script src="https://cdn.jsdelivr.net/npm/@asciidoctor/[email protected]/dist/browser/asciidoctor.min.js"></script>
<!-- docsify-asciidoc -->
<script src="unpkg.com/docsify-asciidoc@^1/dist/main.js"></script>

then you need to enable asciidoctor i your Docsify configuration:

    window.$docsify = {
      asciidocToMarkdown : {
        asciidoctorEnabled: true,
      }
    }

With embedded processor

Include the following snippet in your Docsify index.html:

<!-- docsify-asciidoc -->
<script src="unpkg.com/docsify-asciidoc@^1/dist/main.js"></script>

Example

Check the example/index.html for a complete configuration example.

docsify-asciidoc's People

Contributors

gchiesa avatar giuseppechiesa-tomtom avatar

Stargazers

 avatar  avatar

Watchers

 avatar  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.