Novice, Paragon, Master

    This package has been deprecated

    Author message:

    Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

    gik-doc

    0.0.4 • Public • Published

    fai-doc

    A minimal documentation parser.

    Example

     
    /*» ### I am a subtitle
        I am a description.
     
        - I am a bullet
        - I am another bullet
    */
     
    let foo = 'bar'; //«
     
    /*» I am a paragraph using a multi line comment, which wont have a newline «*/
     
    // I am ignored
    /* I am ignored too */
    let ignored = true;
     
    //» and I'm still part of the same paragraph, but I'm a single line comment //«
    let shown = false;
     
    //» I will be ignored, because I don't have a 'closer'.
     
    /*»
        I won't be shown, nor everything belowe me, since I don't have a 'closer'.
    */
     
    class Test {
     
        constructor(x=true){
            this.x = x;
        }
    }
     
    let test = new Test();

    would compile to:

    I am a subtitle

    I am a description.

    • I am a bullet
    • I am another bullet
     
    let foo = 'bar';
     

    I am a paragraph using a multi line comment, which wont have a newline and I'm still part of the same paragraph, but I'm a single line comment

    Install

    npm i gik-doc

    DownloadsWeekly Downloads

    3

    Version

    0.0.4

    License

    ISC

    Last publish

    Collaborators

    • etor