Docusaurus Soft Design

Open-Source Docusaurus Starter styled with Soft UI Design, an open-source design from Creative-Tim - Actively supported by AppSeed.

• 👉 Docusaurus Soft Design - LIVE Demo
• 👉 Docusaurus Soft Design - video presentation
• 🚀 Free support (email & Discord)

Features

• ✅ Docusaurus v2
• 🚀 Blazing Fast
• ✅ Modern UI: Soft UI Design, Dark-Mode
• ✅ MIT License, Free Support
• ✅ 404 Events Reporting via Email.JS
• ✅ Sticky Videos for YouTube

Installation

• yarn

  yarn

• npm

  npm install

• pnpm

  pnpm install

Local Development

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

• yarn

  yarn start

• npm

  npm run start

• pnpm

  pnpm run start

Build

This command generates static content into the build directory and can be served using any static contents hosting service.

• yarn

  yarn build

• npm

  npm run build

• pnpm

  pnpm run build

Deployment

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Using SSH:

• yarn

  USE_SSH=true yarn deploy

• npm

  USE_SSH=true npm run deploy

• pnpm

  USE_SSH=true pnpm run deploy

Not using SSH:

Note: when prompted for password, enter personal access token.

• yarn

  GIT_USER=<Your GitHub username> yarn deploy

• npm

  GIT_USER=<Your GitHub username> npm run deploy

• pnpm

  GIT_USER=<Your GitHub username> pnpm run deploy

404 Events Reporting via Email.JS

This feature might be useful when we need to log the these events in order to add the missing pages or the corespondent 301 redirects.

$ cp env.sample .env
$ vi .env

Edit email credentials:

EMAILJS_SERVER_ID=REAL_VALUE_HERE
EMAILJS_TEMPLATE_ID=REAL_VALUE_HERE
EMAILJS_PUBLIC_KEY=REAL_VALUE_HERE

Links & Resources

• 👉 Contact AppSeed using the support page
• 👉 Migrate from GitBook to Docusaurus - step-by-step guide

---

Docusaurus Soft Design - Free DOCS Starter provided by AppSeed.