Skip to main content

markdown

Description​

Method that generate a markdown header randomly.

Parameters​

NameTypeDescription
num<Number>How many heading tags will be generated. Default value is 1

Returns​

  • <String>

Usage​

  1. Without passing parameters

    1. code
    console.log(pure.markdown.header());
    1. result
    '# aut'
  2. Describing that i want the level of the header to be 5

    1. code
    console.log(pure.markdown.header(5));
    1. result
    '##### architecto'

emphasis​

Description​

Method that generate random text with markdown emphasis.

Parameters​

NameTypeDescription
types<String>String containing what emphasis generated text will use. Default value is randomized from this types: '_','~','*','**'

Returns​

  • <String>

Usage​

  1. Without passing parameters

    1. code
    console.log(pure.markdown.emphasis());
    1. result
    '*qui* possimus aut'
  2. Describing that i want the text generated to have _ as emphasis

    1. code
    console.log(pure.markdown.emphasis('_'));
    1. result
    'velit _eligendi_ explicabo'

table​

Description​

Method that generate a markdown table randomly.

Parameters​

NameTypeDescription
num<Number>How many table rows will be generated. Default value is 3

Returns​

  • <String>

Usage​

  1. Without passing parameters

    1. code
    console.log(pure.markdown.table());
    1. result
    | head1 | head2 | head3 |
    |:-----:|:-----:|:-----:|
    |perspiciatis|architecto|voluptatem|
    |officiis|animi|non|
    |optio|dolorem|autem|
  2. Describing that i want the table generated to have only 2 rows

    1. code
    console.log(pure.markdown.table(2));
    1. result
    | head1 | head2 | head3 |
    |:-----:|:-----:|:-----:|
    |similique|saepe|laborum|
    |nam|vitae|pariatur|

orderedList​

Description​

Method that generate a markdown ordered list randomly.

Parameters​

NameTypeDescription
num<Number>How many items in list will be generated. Default value is 3

Returns​

  • <String>

Usage​

  1. Without passing parameters

    1. code
    console.log(pure.markdown.orderedList());
    1. result
    1. temporibus
    2. esse
    3. vero
  2. Describing that i want the list generated to have 6 items

    1. code
    console.log(pure.markdown.orderedList(6));
    1. result
    1. itaque
    2. non
    3. quidem
    4. ut
    5. quia
    6. nam

unorderedList​

Description​

Method that generate a markdown unordered list randomly.

Parameters​

NameTypeDescription
num<Number>How many items in list will be generated. Default value is 3

Returns​

  • <String>

Usage​

  1. Without passing parameters

    1. code
    console.log(pure.markdown.unorderedList());
    1. result
    * laborum
    * sapiente
    * id
  2. Describing that i want the list generated to have 6 items

    1. code
    console.log(pure.markdown.unorderedList(6));
    1. result
    * aut
    * temporibus
    * nesciunt
    * molestiae
    * aut
    * ut

inlineCode​

Description​

Method that generate random text with markdown inline code.

Parameters​

NameTypeDescription
N/AN/AThis method doesn't receive any parameters

Returns​

  • <String>

Usage​

  1. Without passing parameters
    1. code
    console.log(pure.markdown.inlineCode());
    1. result
    ` quo `

blockCode​

Description​

Method that generate random text with markdown block code.

Parameters​

NameTypeDescription
N/AN/AThis method doesn't receive any parameters

Returns​

  • <String>

Usage​

  1. Without passing parameters
    1. code
    console.log(pure.markdown.blockCode());
    1. result
        ```javascript
    dolores
    ```