Skip to content

gchiesa/docsify-asciidoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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/core@2.2.6/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.

About

Docsify Plugin for rendering AsciiDoc files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published