Skip to content

Releases: doczjs/docz

v1.0.0-rc.7

29 Mar 23:03
Compare
Choose a tag to compare
v1.0.0-rc.7 Pre-release
Pre-release

Changelog

🐞  Bug Fixes

  • docz-core: add src as prefix on ignore (2bae93b)
  • docz-core: remove DataServer from production build (b8770ec)
  • add missing dependency on examples (af8ec2d)
  • get component filename relative (fix #706) (84b23ea)
  • remove data server from build (8715129)
  • remove modularized lodash packages (d81c568)
  • docz: incompatible props on Link (281cb13)
  • docz-core: base prop for router (9ca39d7)
  • docz-core: entries not initialized on build (#725) (3e99db0)
  • docz-core: resolve symlinks right for the react-docgen (#699) (783a836)
  • docz-theme-default: allows hamburger menu to be opened on mobile (#698) (fd06381)
  • docz-theme-default: apply ignore in props parsing (#723) (6dd068c)
  • docz-theme-default: mobile menu following anchor clicks (#713) (e3bbf1a)
  • docz-theme-default: stop nested ul from rendering flat (#714) (2711e6d)

🚀  Features

  • docz-core: add filterComponents config (e78ae15)
  • docz-core: add watchIgnore config (a0c52db)

v1.0.0-rc.3

21 Mar 15:56
Compare
Choose a tag to compare
v1.0.0-rc.3 Pre-release
Pre-release

🐞  Bug Fixes

  • babel-plugin-export-metadata: update snapshot test (6ca7b87)
  • docz: add window check to useWindowSize hook (#669) (e4d7cb4)
  • docz: merge menus on useMenus (af4afe2)
  • docz: merge new config for useConfig hook (c63bbc8)
  • docz: optional opts for useMenus() (571ffcd)
  • docz: remove config conditional from hooks (6b6f134)
  • docz: remove null return on routes (5bbbbb3)
  • docz-core: config passed on argv (12f6385)
  • docz-core: hot loader and mdx plugins (0531d65)
  • docz-core: initialize config state on data server start (#678) (8c740b8)
  • docz-core: remove dev things from prod build (3f5b5d7)
  • docz-core: remove order from Entry class (e12c37d)
  • docz-core: write first imports (b856168)
  • docz-theme-default: active menu link (5e04e0d)
  • docz-theme-default: add active class manually for gatsby (c3faed3)
  • docz-theme-default: react live error size (7f2e0ff)
  • docz-theme-default: support absolute page elements (#683) (a4ced2b)
  • docz-theme-default: toggle active links on location change (#666) (1274b97)
  • docz-utils: add docz imports on react live scope (01004ed)
  • gatsby-theme-docz: add null fields for entries (b0409a8)
  • gatsby-theme-docz: add ssr support for styled-components (b490010)
  • gatsby-theme-docz: check entries before find on it (8565128)
  • gatsby-theme-docz: create pages hook (2f5765e)
  • gatsby-theme-docz: readme typo (9e3314a)
  • gatsby-theme-docz: throws false for json stringify (289ca75)
  • gatsby theme fixes (dcc5f19)
  • gatsby-theme-docz: check data before access (8f8ed12)
  • gatsby-theme-docz: use options from gatsby-config (#665) (c694bdf)
  • rehype-docz: update tests (548f940)
  • immutable merge with lodash (2fe94d4)
  • remark-docz: visit correct nodes (d5e243d)
  • some general adjustments (0c61f64)
  • load-cfg: merge default config on load (d3b4bc6)
  • use lodash merge instead of deepmerge (18ac37b)
  • docz-theme-default: styles adjustments (aca1bee)
  • gatsby-theme-docz: add specific nodes for entries (26f7f90)
  • define right internal dependencies version (30a91b4)
  • prop types parser (a3cc319)
  • babel-plugin-export-metadata: just define pro non-primitive types (ed78a13)
  • babel-plugin-export-metadata: prettier fix script (3a34b72)
  • docz: remove deduplicated search results (thanks @ivan-dalmet) (1b456f7)
  • docz: sort menu and submenus alphabetically (fbbd51c)
  • docz: use @loadable/component instead of react-imported-component (18f02f2)
  • docz-core: add spaces when write db.json (3a84af3)
  • docz-core: add typescript as dependency (9f314cd)
  • docz-core: apply mdast plugins to entries parse too (c2554b8)
  • docz-core: docgen if file has not component definition (b0fb846)
  • docz-core: exclude node modules from source map loader (1c7c9f7)
  • docz-core: mdx loader options (9114f9b)
  • docz-core: props state parser (87767e8)
  • docz-core: react docgen typescript performance (2967e7c)
  • docz-core: return http server on bundler.start() (cdba3bf)
  • docz-core: run right hook name (f500971)
  • docz-theme-default: fix padding in Playground elements (4af7376), closes /github.com/pedronauck/docz/issues/398#issuecomment-453663552
  • docz-theme-default: force codemirror to refresh (#637) (#638) (e745c7d)
  • docz-theme-default: show cursor on playground editor focus (9f99c30)
  • docz-theme-default: show heading anchor on hover (3e453f5)
  • docz-utils: extract headings from ast (9f8565b)
  • docz-utils: parser config for prettier (54ad0fa)
  • gatsby-theme-docz: hot reload (bf4e440)
  • gatsby-theme-docz: use createPages instead of createPagesStatefully (37b73c6)
  • load-cfg: use babel register in order to require using es6 (7ad3b64)
  • a lot of bug fixes (c10a8bd)
  • scroll to anchor if url has hash (389577f)
  • trim whitespaces before and after class (a184913)
  • use custom rollup config to build instead of libundler (ee42a5a)
  • wrapper property is ignored in (3cda0de)

🚀  Features

  • docz: add filter option for useMenus (aeeb311)
  • docz: use getInitialProps instead of getInitialData (d4406e0)
  • new Props component (80451b1)
  • docz: hooks migrations (f57f987)
  • docz-core: remove ordering deprecated field (39660bb)
  • docz-core: support for configuring the separator during slugifying (10bb134)
  • docz-theme-default: automatically render links with relative path (624bbf0)
  • docz-theme-default: use styled-components instead of emotion (19047fd)
  • gatsby-theme-docz: add custom theme support (fdfddcb)
  • gatsby-theme-docz: add wrapper support (a99d62f)
  • add initial gatsby integration (#630) (70d40cc), closes #609
  • add playground component (cde6511)
  • docgen refactoring (#545) (85499a8)
  • split router logic from theme (a9c26e6)
  • use @reach/router instead of react-router (81a4a82)

⚠️&n...

Read more

v0.13.7

26 Dec 19:50
Compare
Choose a tag to compare

Changelog

🐞  Bug Fixes

  • docz-core: default value for arguments (5644343)
  • docz-core: happypack plugin name (cbf7692)

v0.13.5

19 Dec 19:14
Compare
Choose a tag to compare

Changelog

🐞  Bug Fixes

  • docz-core: add react docgen loader inside happypack (4433561)
  • docz-core: close data server when need (6a2b96a)
  • docz-core: escape template string in playground (#529) (5ab2349)
  • docz-core: public folder in dev mode (abb3626)
  • docz-core: webpack dev server log level (1d72539)
  • docz-theme-default: add default value for rgba of polished (dcb74af)
  • docz-utils: add missing dependency for codesandbox (3a51066)
  • docz-utils: escape code for playground (3fc4187)

v0.13.4

17 Dec 23:48
Compare
Choose a tag to compare

Changelog

🐞  Bug Fixes

  • docz-theme-default: remove overflow from playground wrapper (e007762)

v0.13.3

17 Dec 21:29
Compare
Choose a tag to compare

Changelog

🐞  Bug Fixes

  • docz-core: react hot loader config for hooks (444cac2)

v0.13.2

17 Dec 18:23
Compare
Choose a tag to compare

Changelog

🐞  Bug Fixes

  • docz-core: ensure dir for promise logger (6240f21)

v0.13.1

17 Dec 18:00
Compare
Choose a tag to compare

Changelog

🐞  Bug Fixes

  • docz-core: typescript loader config (01f568e)

v0.13.0

17 Dec 15:53
Compare
Choose a tag to compare

Changelog

0.13.0 (2018-12-17)

🐞  Bug Fixes

  • docz: ts warning (19ccc09)
  • docz-core: add setMaxListener for chokidar watchers (6053c16)
  • docz-core: log level based on debug argument (507e149)
  • docz-core: node path resolve modules merge (27102fd)
  • docz-core: turn off htmlMinifier when loading from templates (#518) (9cb0e1d)
  • docz-core: use webpack-dev-server instead of webpack-serve (4157e05)

🚀  Features

  • docz-core: add onCreateWebpackChain hook (70bb242)
  • docz-core: add promise logger using progress-estimator (2797608)
  • docz-core: use NODE_PATH to resolve modules (#516) (cc86f93)
  • docz-theme-default: set max lines before scroll editor (#519) (698261b)

onCreateWebpackChain

Now you can customize the webpack configuration using webpack-chain by modifying it using onCreateWebpackChain inside your doczrc.js or when you're creating your plugin.

import { createPlugin } from 'docz-core'

const plugin = createPlugin({
  onCreateWebpackChain: (config) => {
    /** add your logic here */
  }
})

export default {
  plugins: [plugin],
  onCreateWebpackChain: (config) => {
    /** add your logic here */
  }
}

Resolve modules using NODE_PATH

If you want to resolve modules from some path, now you can set the NODE_PATH env variable that will be used as a path to resolve your imports like in create-react-app. You can set your env variables using .env file or directly on your npm script.

// .env
NODE_PATH="src"

Then you simply import modules resolved from your path:

// before
import { SomeModule } from 'src/resolved/path'

// after
import { SomeModule } from 'resolved/path'

Set editor max line before scrolling

In the previous version of docz, when the editor preview had more than 11 lines of code it was scrolled, this was a fixed number. Now, you can configure with how many lines you want to scroll your editor using the themeConfig.linesToScrollEditor inside your doczrc.js:

export default {
  themeConfig: {
    linesToScrollEditor: 8
  }
}

v0.12.17

14 Dec 14:32
Compare
Choose a tag to compare

Changelog

🐞  Bug Fixes

  • docz: cycled dependency (5132195)
  • docz-theme-default: link color (21d58fb)
  • docz-theme-default: some fixes on styles (a17e914)
  • docz-theme-default: use theme getter instead of literal obj access (89e1d03)

Add theme default as a dependency

Since this release, now you need to install docz-theme-default together on your project:

$ yarn add docz docz-theme-default --dev