docusaurus-init

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:

1. Have Node >= 8.x installed. Yarn >= 1.5 is recommended as well.
2. Go into the root of your GitHub repo directory where you will be creating the docs.
3. 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.

Changelog

2.0.0-alpha.35 (2019-11-17)

:rocket: New Feature

• docusaurus-theme-classic
  • #1965 feat(v2): add ability specify link in footer logo (@lex111)

:bug: Bug Fix

• docusaurus-mdx-loader, docusaurus-theme-classic
  • #1992 fix(v2): static phrasing content should be rendered correctly in TOC (@endiliey)
• docusaurus-theme-classic
  • #1999 fix(v2): remove hashbang when click on category (@lex111)
  • #1962 fix(v2): make not clickable post title on post item page (@lex111)
  • #1980 fix(v2): remove invalid label attribute of footer links (@lex111)
  • #1978 fix(v2): use regular div instead of main tag for wrapper layout page (@lex111)
  • #1975 fix(v2): move header inside article tag in doc page (@lex111)
  • #1974 fix(v2): remove invalid attributes of nav links (@lex111)
  • #1963 fix(v2): remove empty containers when no data in blog pages (@lex111)
  • #1966 fix(v2): remove duplicate meta tags (@lex111)
• docusaurus-plugin-content-docs
  • #1994 fix(v2): throw error if first level item of a sidebar is not category (@endiliey)

:nail_care: Polish

• docusaurus-theme-search-algolia
  • #2001 fix(v2): improve UI of search (@lex111)
• docusaurus-theme-classic
  • #1991 fix(v2): remove accessible anchors via keyboard (@lex111)
  • #1987 refactor(v2): replace h1 tag with h2 in blog list pages (@lex111)
  • #1981 fix(v2): use tag time for showing last update of doc item (@lex111)
  • #1977 feat(v2): add aria-label to read more links for a11y (@lex111)
  • #1964 fix(v2): use tag time for showing post item date (@lex111)
• docusaurus-plugin-content-docs
  • #1994 fix(v2): throw error if first level item of a sidebar is not category (@endiliey)
• Other
  • #1986 fix(v2): remove obsolete iframe attributes (@lex111)
• docusaurus-init
  • #1982 feat(v2): add FB link to footer (@lex111)
• docusaurus-plugin-content-blog
  • #1968 refactor(v2): simplify blog truncate function (@endiliey)

:memo: Documentation

• Other
  • #1988 docs(v2): fix syntax highlighting for YML code blocks (@lex111)
  • #1976 docs(v2): Add section to blog document about feed location (@vinnytheviking)
  • #1970 docs(v2): update configureWebpack utility functions (@jamiedavenport)
• docusaurus-1.x
  • #1961 docs(v1): remove exclusive language (@ericcarboni)

:house: Internal

• Other
  • #2002 fix(v2): fix browser window menu icon on smaller screen (@lex111)
  • #1986 fix(v2): remove obsolete iframe attributes (@lex111)
• docusaurus-init
  • #1982 feat(v2): add FB link to footer (@lex111)
• docusaurus-1.x, docusaurus-init-1.x, docusaurus-init, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus
  • #1985 chore(v2): update dependencies (@endiliey)

:running_woman: Performance

• docusaurus
  • #1979 perf(v2): reduce main bundle size by using es5 if possible (@endiliey)

Committers: 6

• Alexey Pyltsyn (@lex111)
• Endi (@endiliey)
• Eric Carboni (@ericcarboni)
• Jamie Davenport (@jamiedavenport)
• Nick McCormick (@kenning)
• Vincent van der Walt (@vinnytheviking)