Skip to content

v0.4.0

Choose a tag to compare

@github-actions github-actions released this 02 Feb 04:41
2f77232

💥 Breaking Change

  • [BREAKING] Define Docfy plugin system + Rehype plugins + @docfy/plugin-with-prose (#75) @josemarluedke

Details

  • Plugin system has now been defined, and it breaks any previous Docfy plugin.
  • Docfy no longer renders content to HTML using remark-html. In order to support rehype plugins, we have migrated to remark-rehype and rehype-stringify.
  • Removes the need to use .default on requiring the core:
    -const Docfy = require('@docfy/core').default;
    +const Docfy = require('@docfy/core');
    Using .default no longer will work.
  • Drops support for Node v10

Other changes

  • GitHub Flavored Markdown is now supported by default using remark-gfm
  • New @docfy/plugin-with-prose optional plugin for TailwindCSS users that would like to add .prose classes to markdown content. This will automatically skip any HTML or Ember Components in the markdown.

For Ember users:

If you are not using any custom docfy plugin, this upgrade will be most likely transparent.

🚀 Enhancement

🏠 Internal

📦 Dependencies


Contributors

@josemarluedke


For full changes, see the comparison between v0.3.1 and v0.4.0