Migrate to docusaurus

.eslintrc.json

@@ -313,4 +313,4 @@
         "template-curly-spacing": ["error", "never"],
         "yield-star-spacing": ["error", "before"]
     }
-}
+}

.gitignore

@@ -1,24 +1,20 @@
-# Logs
-logs
-*.log
+# Dependencies
+/node_modules
 
-# Runtime data
-pids
-*.pid
-*.seed
+# Production
+/build
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
+# Generated files
+.docusaurus
+.cache-loader
 
-# Coverage directory used by tools like istanbul
-coverage
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-bower_components
-node_modules
-
-# Dotfile detritus
+# Misc
 .DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

CHANGELOG.md

@@ -0,0 +1,19 @@
+# CHANGELOG
+
+## Migrate to Docusaurus
+
+- Moved all markdown from `content/en` to `docs/`
+- Removed `.eslintignore` as not required.
+- Removed `data/redirects.json` and added redirects in `docusaurus.config.js`.
+- Removed `data/toc.json` as the hierarchy is now maintained in the sidebar.
+- Removed all html files.
+- Removed `content/en/index.md` as the list can be browsed from the sidebar.
+- Replaced `.gitignore` with Docusaurus generated.
+- Added Docusaurus generated `babel.config.js`.
+- Added contribute page.
+- Changes in markdown content:
+  - Replaced `{% example "Inline tag used within a block tag" %}` with `- **Inline tag used within a block tag**`.
+  - Removed `{% endexample %}`.
+  - Removed `.html` suffix from internal links.
+  - Prettier changes.
+

README.md

@@ -6,35 +6,34 @@ If you just want to read the documentation, please visit [Use JSDoc][use-jsdoc].
 
 ## Contributing to the documentation
 
-The HTML docs are generated with [Metalsmith][] and [Gulp][]. If you'd like to contribute to the
-docs, make sure Node.js and npm are installed, then follow these steps:
+The documentation site is based on [Docusaurus](https://docusaurus.io/). If you'd like to contribute to the docs, make sure Node.js and npm are installed, then follow these steps:
 
 1. Clone this repository:
 
-        [email protected]:jsdoc3/jsdoc3.github.com.git
+        [email protected]:jsdoc/jsdoc.github.io.git
 
-2. Install Bower and Gulp globally:
 
-        npm install -g gulp
-        npm install -g bower
-
-3. Install the dependencies:
+2. Install the dependencies:
 
         npm install
-        bower install
 
-4. Make your changes in the `content` directory, which contains the source files for the docs.
+3. Make your changes in the `docs` directory, which contains the source files for the docs.
 
     The first few lines of each source file contain [YAML][] front matter, which is metadata in
     [YAML][] format. If you need to use the character `@` or `[` at the start of a YAML value, you
     can escape it with a backslash. For example, write `title: @class` as `title: \@class`.
 
-5. Rebuild the HTML files:
+4. Spawn your local instance:
+
+        npm run
 
-        gulp
+5. Build and serve locally:
+
+        npm run build
+        npm run serve
 
-6. Review the updated HTML files, and make sure your changes look okay. In particular, if you edited
-the YAML front matter, make sure your changes are reflected in the generated HTML files.
+6. Review the updated markdown files, and make sure `npm run build` completes successfully and your changes look okay. In particular, if you edited
+the YAML front matter, make sure your changes are reflected in the generated site.
 
 7. Submit a pull request with your changes.