docusaurus-init

Initialization script for Docusaurus

2.0.0-alpha.62
Source
npm

Version published: 4 years ago

Weekly downloads: 944; increased by117.51%

Maintainers: 3

Weekly downloads

Created: 7 years ago

Source

`docusaurus-init`

An initialization script for Docusaurus.

What does it do?

Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

Have Node >= 8.x installed. Yarn >= 1.5 is recommended as well.
Go into the root of your GitHub repo directory where you will be creating the docs.
npx docusaurus-init

If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

Find out more in the official docs.

2.0.0-alpha.62 (2020-08-28)

:rocket: New Feature

docusaurus-plugin-content-docs, docusaurus-theme-classic
- #3357 feat(v2): docs version configuration: lastVersion, version.{path,label} (@slorber)
- #3328 feat(v2): Provide docs plugin theme typing (@SamChou19815)
docusaurus-theme-classic
- #3356 feat(v2): Provide type definitions for remaining theme-classic components (@SamChou19815)
- #3274 feat(v2): add TOC to blog posts (@amy-lei)
docusaurus-plugin-content-pages, docusaurus-theme-classic
- #3354 feat(v2): Provide type definitions for MDXPage from page plugin (@SamChou19815)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic
- #3348 feat(v2): Provide typing to most of the theme-classic components (@SamChou19815)
docusaurus-init, docusaurus-plugin-content-blog
- #3284 feat(v2): blog slug frontmatter (@JeanMarcSaad)
docusaurus-init, docusaurus-theme-bootstrap
- #2981 feat(v2): bootstrap theme, preset, template, CI previews (@fanny)
docusaurus-plugin-content-blog, docusaurus-theme-classic
- #3267 feat(v2): Provide blog plugin theme typing (@SamChou19815)
docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-debug, docusaurus-preset-classic, docusaurus-theme-bootstrap, docusaurus-types, docusaurus
- #3229 feat(v2): debug pages + debug layout + ability to debug content (@slorber)
docusaurus-theme-classic, docusaurus-types, docusaurus
- #3021 feat(v2): update swizzle command to suggest component/theme (@anshulrgoyal)
docusaurus-mdx-loader, docusaurus-plugin-content-pages
- #3196 feat(v2): add support to ignore files in pages plugin (@anshulrgoyal)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils-validation, docusaurus
- #3204 feat(v2): blog + docs multi-instance plugins (@slorber)
docusaurus-mdx-loader
- #3096 feat(v2): add support to import assets using relative link in markdown syntax (@anshulrgoyal)

:bug: Bug Fix

docusaurus-migrate
- #3358 fix(v2): fix migrate cli paths (sidebars/customcss) (@slorber)
docusaurus
- #3311 fix(v2): add https support in webpack devserver (@arcvats)
- #3313 fix(v2): resolve webpack loaders from siteDir/node_modules (@anshulrgoyal)
- #3308 fix(v2): brokenLinks should not report links that belong to an existing folder if folder/index.html exists (@slorber)
- #3273 fix: logic error while deciding deploymentBranch (@thehanimo)
- #3281 fix(v2): allow swizzling of component even if case doesn't match (@anshulrgoyal)
- #3222 fix(v2): update react-loadable-ssr-addon to solve yarn2 error (@slorber)
- #3191 fix(v2): add missing lodash.flatmap dependency (@ylemkimon)
docusaurus-plugin-content-blog, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-bootstrap, docusaurus-theme-search-algolia, docusaurus-types
- #3355 fix(v2): Add missing dependencies to packages (@SamChou19815)
docusaurus-theme-classic
- #3352 fix(v2): Allow the alt for the logo to be empty (@Vinnl)
- #3240 fix(v2): navbar dropdown opened with tab, not closing on click outside (@Ako92)
docusaurus-mdx-loader, docusaurus
- #3347 fix(v2): linking to asset or external html page -> don't use history.push() (@slorber)
docusaurus-1.x
- #3340 fix(v1): show images after one line code block (@adinaja)
docusaurus-1.x, docusaurus
- #3290 fix(v1,v2): Add initial-scale=1.0 to all meta viewport tags (@nebrelbug)
docusaurus-theme-search-algolia
- #3297 fix(v2): keep DocSearch state on remounts (@francoischalifour)
- #3280 fix(v2): allow search page swizzle (@Ako92)
- #3263 fix(v2): do not index search pages (@slorber)
docusaurus-mdx-loader, docusaurus-plugin-content-pages
- #3283 fix(v2): pass images in static dir to webpack-loader (@anshulrgoyal)
Other
- #3269 fix(v2): website feedback page hydration bug (@mecm1993)
- #3200 fix(v1): self-host user images (@leoigel)
docusaurus-plugin-google-gtag
- #3243 fix(v2): GTM, send page_view events on navigate (@govardhan-srinivas)
docusaurus-plugin-content-docs, docusaurus-utils
- #3262 fix(v2): doc path special char (space or other) should lead to a valid slug (@slorber)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils-validation, docusaurus
- #3247 fix(v2): modify validation schema and tests for rehype/remark + remove duplicate dependency (@teikjun)
docusaurus-init
- #3258 fix(v2): fix template alt image prop (@slorber)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils-validation, docusaurus
- #3227 fix(v2): relax URI validation (@anshulrgoyal)
docusaurus-init, docusaurus-plugin-content-docs
- #3228 fix(v2): deprecate docs homePageId in favor of frontmatter "slug: /" (@slorber)
docusaurus-plugin-content-docs, docusaurus
- #3225 fix(v2): swizzle minor improvements (@slorber)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #3210 fix(v2): fix theme validation for prism field and add tests (@teikjun)
docusaurus-plugin-content-docs
- #3192 fix(v2): add missing chalk and lodash dependencies (@ylemkimon)

:nail_care: Polish

docusaurus-module-type-aliases, docusaurus
- #3244 chore(v2): tighten up the TypeScript onboarding (@orta)
docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils, docusaurus
- #3245 refactor(v2): docs plugin refactor (@slorber)
docusaurus
- #3188 fix(v2): Add a missing whitespace before prompt to use npm run serve (@SamChou19815)

:memo: Documentation

Other
- #3346 docs(v2): add draft doc (@imskr)
- #3336 docs(v2): add Nisarag to Fellows section (@FocalChord)
- #3335 docs(v2): update team profile (@yangshun)
- #3334 docs(v2): add Drew to Fellows section (@Drewbi)
- #3333 docs(v2): add anshul and teikjun to fellows section of team page (@teikjun)
- #3326 docs(v1): showcase user Casbin (@hsluoyz)
- #3316 docs(v1): add Global CTO Forum to users (@MirzayevFarid)
- #3310 docs(v2): add "T-Regx" website to showcase (@Danon)
- #3307 docs(v2): showcase SpotifyAPI-NET (@JohnnyCrazy)
- #3295 docs(v2): showcase Oxidizer (@vandreleal)
- #3287 docs: update README.md with some grammatical corrections (@shalinikumari50)
- #3271 docs(v2): fix typo (@thehanimo)
- #3277 docs(v1): Add Radity to users (@tolunayakbulut)
- #3276 docs: corrected some few typos in the docusaurus tech docs (@ajifrank75)
- #3249 docs(v2): fix migration command (@BogdanDor)
- #3248 Added twitter badge and modified discord Badges (@Souravdey777)
- #3251 docs(v2): fix migration command for earlier versions (@teikjun)
- #3252 docs(v2): docs typos (@olawanlejoel)
- #3111 docs(v2): clarify theme-original and theme-init (@Jonathannsegal)
- #3232 docs(v2): showcase user QA-Board (@arthur-flam)
- #3205 docs: format reference links (@lebogangolifant)
- #3194 docs(v2): Added switch config docs to theme-classic API (@Drewbi)
- #3201 docs(v2): removed duplicate text under "Using React" section (@boosh511)
- #3186 docs(v1): formatting changelog (@slorber)
docusaurus
- #3202 fix(v2): fix svg loader (@anshulrgoyal)

:house: Internal

docusaurus-migrate
- #3323 test(v2): Add unit test for migration of config file (@BogdanDor)
docusaurus-theme-classic
- #3343 refactor(v2): announcement bar bad spelling + minor refactors (@slorber)
docusaurus-plugin-content-blog
- #3339 test(v2): make blog posts unit test ordering determinate (@BogdanDor)
docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-types
- #3306 chore(v2): Define type for markdown right table of contents (@SamChou19815)
docusaurus-module-type-aliases, docusaurus
- #3244 chore(v2): tighten up the TypeScript onboarding (@orta)
docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils, docusaurus
- #3245 refactor(v2): docs plugin refactor (@slorber)
docusaurus
- #3282 chore(v2): fix javascript-serialize vulnerability (@slorber)
- #3265 chore(v2): upgrade terser-webpack-plugin (@dschaller)
Other
- #3241 chore(deps): bump prismjs from 1.20.0 to 1.21.0 (@dependabot[bot])
- #3259 chore(v2): fix slow commits due to lint-staged (@slorber)
- #3197 chore(v2): lockfile update (@slorber)
docusaurus-1.x
- #3218 chore(v1): release 1.14.6 (@slorber)

:running_woman: Performance

docusaurus-plugin-client-redirects, docusaurus-theme-search-algolia, docusaurus
- #3238 refactor(v2): precompile ETA templates (@slorber)

Committers: 39

Ali Hosseini (@Ako92)
Amy Lei (@amy-lei)
Anshul Goyal (@anshulrgoyal)
Archit (@arcvats)
Arthur Flam (@arthur-flam)
Ben Gubler (@nebrelbug)
Bogdan Doroschenko (@BogdanDor)
Daniel Wilkowski (@Danon)
Derek (@dschaller)
Drew Alexander (@Drewbi)
Fanny (@fanny)
Franklyn Chisom (@ajifrank75)
François Chalifour (@francoischalifour)
Govardhan Srinivas (@govardhan-srinivas)
Hani Mohammed (@thehanimo)
Jean-Marc Saad (@JeanMarcSaad)
Jonas Dellinger (@JohnnyCrazy)
Jonathan (@Jonathannsegal)
Manuel Cepeda (@mecm1993)
Mirzayev Farid (@MirzayevFarid)
Nisarag (@FocalChord)
Olawanle Joel (@olawanlejoel)
Orta Therox (@orta)
Sam Zhou (@SamChou19815)
Shubham Kumar (@imskr)
Sourav Dey (@Souravdey777)
Sébastien Lorber (@slorber)
Teik Jun (@teikjun)
Tolunay Akbulut (@tolunayakbulut)
Vandré Leal (@vandreleal)
Vincent (@Vinnl)
Yang Luo (@hsluoyz)
Yangshun Tay (@yangshun)
@adinaja
@leoigel
@shalinikumari50
alex busnelli (@boosh511)
lebogang Olifant (@lebogangolifant)
ylemkimon (@ylemkimon)

Keywords

FAQs

What is docusaurus-init?

Is docusaurus-init popular?

Is docusaurus-init well maintained?

Package last updated on 28 Aug 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