Neurotic and Probably Misinformed

    vite-plugin-asciidoc
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.2 • Public • Published

    npm

    Vite Plugin for Asciidoc

    Vite plugin to import .adoc files as html

    Install

    npm install -D vite-plugin-asciidoc

    Usage

    In your vite configuration:

    import { createAsciidocPlugin } from 'vite-plugin-asciidoc';
    
    export default {
        // ...
        plugins: [
            createAsciidocPlugin()
        ]
    }

    In your code:

    import help, { attributes } from './help.adoc';
    
    console.log(help); // adoc file converted to html
    console.log(attributes); // attributes of source adoc file

    Configuration

    You can specify most of the options that comes to asciidoctor. Few of them:

    • attributes - Any number of built-in or user-defined attributes;
    • safe - Safe mode (unsafe, safe, server or secure).

    Typescript

    In TypeScript project you will need to declare typedefs for .adoc files:

    declare module '*.adoc' {
        const content: string;
        export default content;
    
        const attributes: Record<string, unknown>;
        export { attributes };
    }

    Save it as shims-adoc.d.ts for instance.

    Contributing

    Bug reports and pull requests are welcome on GitHub at https://github.com/djaler/vite-plugin-asciidoc.

    Thanks

    Thanks to html-loader for the html assets processing code.

    License

    The package is available as open source under the terms of the MIT License.

    Install

    npm i vite-plugin-asciidoc

    DownloadsWeekly Downloads

    20

    Version

    0.0.2

    License

    MIT

    Unpacked Size

    11.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • djaler