diff --git a/CHANGELOG.md b/CHANGELOG.md index 8458cb6..ccc9d8f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ Any non-code changes should be prefixed with `(docs)`. See `PUBLISH.md` for instructions on how to publish a new version. --> +- (minor) Make Collapsible Heading plugin not enabled by default ## v1.15.0 - c5d8617 diff --git a/README.md b/README.md index 0328c27..2418c8c 100644 --- a/README.md +++ b/README.md @@ -210,7 +210,7 @@ Nesting multiple collapsible sections is supported. **Options:** Pass options for this plugin as the `collapsible_heading` property of the `do-markdownit` plugin options. -Set this property to `false` to disable this plugin. +This plugin is disabled by default, pass an object to enable it. - `levels` (`number[]`, optional, defaults to `[ 1, 2, 3, 4, 5, 6 ]`): List of heading tags to wrap (ex: `2`). - `open` (`boolean`, optional, defaults to `true`): Flag indicating if the wrapped sections should be expanded by default. diff --git a/fixtures/full-output.html b/fixtures/full-output.html index fb069e6..cca01ff 100644 --- a/fixtures/full-output.html +++ b/fixtures/full-output.html @@ -1,28 +1,14 @@ -
-

Title Header (H1 header)

- -
-

Introduction (H3 header)

-

This is some placeholder text to show examples of Markdown formatting. We have a full article template you can use when writing a DigitalOcean article. Please refer to our style and formatting guidelines for more detailed explanations: https://do.co/style

-
-
-

Prerequisites (H2 header)

-

Before you begin this guide you’ll need the following:

-
-
-

Step 1 — Basic Markdown

-

This is italics, this is bold, this is underline, and this is strikethrough.

-
-

Step 3 — Callouts

-

Here is a note, a warning, some info and a draft note:

Note: Use this for notes on a publication.

@@ -240,11 +218,7 @@

You can also mention users by username:

@MattIPv4

-

-
-

Step 4 — Layout

-

Columns allow you to customise the layout of your Markdown:

@@ -272,59 +246,36 @@

Pass open as the first argument to the summary section to do this.

You can also pass closed, though this is the same as not passing anything before the summary.

-
-
-

Step 5 — Embeds

- -
-

YouTube

-

Embedding a YouTube video (id, height, width):

Both the width and height are optional, with the defaults being 480 and 270 respectively.
The width/height set are treated as maximums – the video will scale down to fit the available space, maintaining the aspect ratio.

-
-
-

Wistia

-

Embedding a Wistia video (id, height, width):

As with the YouTube embed, both the width and height are optional and have the same defaults.
The same behaviour applies to the width/height set, with responsive scaling.

-
-
-

Vimeo

-

Embedding a Vimeo video (url, height, width):

As with the YouTube embed, both the width and height are optional and have the same defaults.
The same behaviour applies to the width/height set, with responsive scaling.

-
-
-

DNS

-

Embedding DNS record lookups (hostname, record types…):

Perform a full DNS lookup for digitalocean.com
-
-
-

Glob

-

Demonstrating how glob matching works (pattern, tests…):

@@ -337,11 +288,7 @@

CodePen

-

To provide code examples, you could embed a CodePen with a username and pen ID:

See the Pen vwPzeX by MattCowley (@MattCowley) on CodePen. @@ -358,11 +305,7 @@

Glitch

-

Alternatively, you may want to embed a code example from Glitch with a project slug: