@docusaurus/init

Create Docusaurus app easily

2.0.0-alpha.59
Source
npm

Version published: 4 years ago

Weekly downloads: 1K; increased by62.99%

Maintainers: 5

Weekly downloads

Created: 5 years ago

Source

Templates

Official templates provided by Docusaurus. They are designed to be selected when using the npx @docusaurus/init@next init [name] [template] CLI command.

Guide to Test Templates for Developer

yarn install in the root of the repo (one level above this directory).
Go to any template's directory, example: cd classic && yarn start.

2.0.0-alpha.59 (2020-07-24)

:rocket: New Feature

docusaurus-migrate, docusaurus-plugin-client-redirects
- #3015 feat: automate migration from v1 to v2 (@anshulrgoyal)
docusaurus-init
- #3105 feat(v2): add docusaurus script for npm users (@slorber)
docusaurus-theme-search-algolia
- #2815 feat(v2): introduce DocSearch v3 search (@francoischalifour)
docusaurus-init, docusaurus-types, docusaurus
- #3059 feat(v2): broken links detection (@slorber)
docusaurus-plugin-content-docs, docusaurus-utils
- #3084 feat(v2): absolute slugs and slug resolution system (@slorber)
docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
- #3069 feat(v2): support for adding relative images and handling broken image links (@anshulrgoyal)
docusaurus-init, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-debug, docusaurus-theme-classic, docusaurus-types, docusaurus
- #2971 feat(v2): global data + useGlobalData + docs versions dropdown (@slorber)
docusaurus-init, docusaurus
- #3080 feat(v2): add support for serve command (@anshulrgoyal)
docusaurus-module-type-aliases, docusaurus-plugin-debug, docusaurus-types, docusaurus
- #3058 feat(v2): useDocusaurusContext().siteMetadata (@slorber)
docusaurus
- #3032 feat(v2): notify users when docusaurus version is outdated (@teikjun)
- #3033 feat(v2): add useBaseUrlUtils() hook (@slorber)
- #3006 feat(v2): prompt user when default port is in use (@taylorallen0913)
docusaurus-module-type-aliases, docusaurus-plugin-debug, docusaurus
- #3050 feat(v2): Collect plugin versions to allow them to be inspected in debug plugin (@SamChou19815)
docusaurus-theme-classic
- #3038 feat(v2): Support keywords meta in blog posts (@dpkg)
- #2974 feat(v2): Error when hooks depends on context is used outside of Layout (@SamChou19815)
docusaurus-plugin-pwa, docusaurus
- #2205 feat(v2): Plugin for Offline/PWA support (@codemonkey800)
docusaurus-plugin-ideal-image, docusaurus-types, docusaurus
- #2994 feat(v2): configureWebpack merge strategy + use file-loader for common asset types (@slorber)
docusaurus-plugin-content-docs
- #2989 feat(v2): add disableVersioning config to docs plugin (@slorber)
- #2877 feat(v2): allow skipping build docs for next version (@lex111)
docusaurus-1.x
- #2955 feat(v1): add deletedDocs config to fix unwanted versioning fallback (@aldeed)
docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-types, docusaurus
- #2943 feat(v2): option and config validation life cycle method for official plugins (@anshulrgoyal)

:boom: Breaking Change

docusaurus-init, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-debug, docusaurus-theme-classic, docusaurus-types, docusaurus
- #2971 feat(v2): global data + useGlobalData + docs versions dropdown (@slorber)
docusaurus-theme-classic, docusaurus
- #3012 fix(v2): refactor color mode system (@slorber)

:bug: Bug Fix

docusaurus
- #3107 fix(v2): broken links detector: ignore existing folders (@slorber)
- #3112 fix(v2): baseUrl is wrongly appended to anchor links (@slorber)
- #3063 fix(v2): classify link hrefs with protocol identifier as internal (@svtfrida)
docusaurus-theme-classic
- #3106 fix(v2): dropdown navbar item: validation too strict (@slorber)
- #3029 fix(v2): change description for blog post paginator (@teikjun)
docusaurus-plugin-content-docs
- #3108 fix(v2): fix docs instance path typo (@slorber)
docusaurus-plugin-content-pages
- #3025 fix(v2):pass siteConfig as prop to pages (@anshulrgoyal)
docusaurus-init
- #3008 chore(v2): Add E2E test for yarn v2 (@SamChou19815)
Other
- #3017 fix(v2): fix broken links on versions page (@teikjun)
docusaurus-theme-classic, docusaurus
- #3012 fix(v2): refactor color mode system (@slorber)
docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
- #3001 fix(v2): refactor routes.ts + add route hash for chunkNames key (@slorber)
docusaurus-plugin-client-redirects, docusaurus-utils, docusaurus
- #3010 fix(v2): make client-redirect-plugin not baseUrl sensitive (@teikjun)
docusaurus-1.x
- #2993 fix(relative path): last update date and by isn’t generated if localh… (@amirulahmad)
docusaurus-plugin-client-redirects
- #2969 fix: fromExtensions and toExtensions translation when used with baseUrl (@jknoxville)

:nail_care: Polish

docusaurus-theme-classic, docusaurus
- #3088 improve navbar menu (@slorber)
docusaurus-mdx-loader
- #3087 refactor(v2): async md image transformer + pathname protocol as an escape hatch (@slorber)
docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-theme-live-codeblock, docusaurus-types
- #2970 feat(v2): add option validation for remaining official plugins (@teikjun)
docusaurus
- #2987 chore(v2): use joi for config validation (@anshulrgoyal)

:memo: Documentation

#3026 docs(v2): add documentation for migration command (@teikjun)
#3094 docs(v2): showcase user Clutch (@danielhochman)
#3101 docs(v2):Add azure-pipelines CI guide (@ayan-b)
#3098 docs: Add azure-pipelines CI guide (@ayan-b)
#3086 doc(v2): replace heading position (@eKhattak)
#3082 fixing few typos and enhancing few sentences clarity (@aladin002dz)
#3078 Updated link for #docusaurus-2-dev discord (@jordanliu)
#3076 docs(v2): showcase Runlet (@vandreleal)
#3040 docs(v2): correct the documentation for docs-only mode (@teikjun)
#3034 docs(v2): showcase user Tasit (@pcowgill)
#3022 docs(v2): showcase Eta (@nebrelbug)
#3011 docs(v1): external links (@slorber)
#2997 docs(v2): Document TypeScript support (@SamChou19815)
#2973 docs(v2): Fix typo in markdown-features (@ehsanjso)
#2991 Showcase Amphora Data (@xtellurian)
#2983 docs(v2): add plugin redirects production build note (@slorber)
#2967 docs(v2): fix typos in plugin-content examples (@hi-matbub)
#2960 doc(v2): publish doc update after alpha.58 release (@slorber)
#2966 docs(v2): fix typo in plugin-content-pages example (@hi-matbub)

:house: Internal

docusaurus-migrate
- #3113 chore(v2): ability to test the migration cli easily (@slorber)
Other
- #3099 fix(v2): netlify.toml shouldn't affect v1 site deployment config (@slorber)
- #3068 chore(deps): bump lodash from 4.17.15 to 4.17.19 (@dependabot[bot])
- #2958 docs(v2): rename 2.0.0-alpha.57 to 2.0.0-alpha.58 (@yangshun)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus
- #3093 fix(v2): fix recent baseurl issues (@slorber)
docusaurus-mdx-loader
- #3087 refactor(v2): async md image transformer + pathname protocol as an escape hatch (@slorber)
docusaurus-plugin-pwa, docusaurus
- #3055 chore(v2): Adopt corejs 3 and only import at entry point (@SamChou19815)
docusaurus-init, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-utils, docusaurus
- #2998 chore(v2): refactor yarn tsc to yarn build + add theme-classic watch mode (@slorber)
docusaurus-init
- #3008 chore(v2): Add E2E test for yarn v2 (@SamChou19815)
docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
- #3001 fix(v2): refactor routes.ts + add route hash for chunkNames key (@slorber)
docusaurus
- #3007 fix(v2): Add two missing docusaurus core babel dependency (@SamChou19815)
- #2987 chore(v2): use joi for config validation (@anshulrgoyal)
- #2950 chore(v2): Implement a simple E2E testing mechanism for docusausus start (@SamChou19815)
docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-theme-live-codeblock, docusaurus-types
- #2970 feat(v2): add option validation for remaining official plugins (@teikjun)
docusaurus-theme-classic
- #2996 chore(v2): Merge devDependencies in theme-classic (@SamChou19815)
- #2977 chore(v2): Remove extraneous package-lock.json (@SamChou19815)
docusaurus-plugin-client-redirects
- #2962 Feat: replace yup with joi for cleaner validation (@anshulrgoyal)
docusaurus-init, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus, lqip-loader
- #2976 chore(v2): Fix more eslint errors (@SamChou19815)
docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-sitemap, docusaurus-utils, docusaurus, lqip-loader
- #2972 chore(v2): Fix a lot of eslint warnings (@SamChou19815)

Committers: 25

Alexey Pyltsyn (@lex111)
Amirul Ahmad (@amirulahmad)
Anshul Goyal (@anshulrgoyal)
Arsalan Khattak (@eKhattak)
Ayan Banerjee (@ayan-b)
Ben Gubler (@nebrelbug)
Daniel Hochman (@danielhochman)
Deepak Giri (@dpkg)
Eric Dobbertin (@aldeed)
François Chalifour (@francoischalifour)
Frida Hjelm (@svtfrida)
Jeremy Asuncion (@codemonkey800)
John Knox (@jknoxville)
Jordan Liu (@jordanliu)
Mahfoudh Arous (@aladin002dz)
Paul Cowgill (@pcowgill)
Rian Finnegan (@xtellurian)
Sam Zhou (@SamChou19815)
Sébastien Lorber (@slorber)
Taylor Allen (@taylorallen0913)
Teik Jun (@teikjun)
Vandré Leal (@vandreleal)
Yangshun Tay (@yangshun)
ehsan jso (@ehsanjso)
matbub (@hi-matbub)

FAQs

What is @docusaurus/init?

Is @docusaurus/init popular?

Is @docusaurus/init well maintained?

Package last updated on 24 Jul 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install