@kev_nz/publisher

    4.0.1 • Public • Published

    Publisher

    npm version

    Publish your readme to gh-pages.

    Usage

    npm install @kev_nz/publisher --save-dev

    Then run

    npx publisher

    Custom config

    To use custom html create a folder called .assets in the root of your project and add a head.html file with all the content before the readme contents, and a foot.html in the .assets folder for all content after the readme contents. The code highlighting uses Highlightjs for styles.

    Additonally, anything else placed in the .assets folder will be copied to the dist folder and published along with readme file.

    Setup

    The structure

    - .assets
    -- head.html
    -- foot.html
    -- extends.css
    -- myimage.jpg
    - readme.md
    

    The published dist folder content

    - index.html
    - styles.css
    - extends.css
    - myimage.jpg
    

    Install

    npm i @kev_nz/publisher

    DownloadsWeekly Downloads

    85

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    83.9 kB

    Total Files

    22

    Last publish

    Collaborators

    • kev_nz