Skip to content

Latest commit

 

History

History
113 lines (90 loc) · 2.54 KB

README.md

File metadata and controls

113 lines (90 loc) · 2.54 KB

Docusaurus Soft Design

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

Features

  • 🚀 Blazing Fast - SEE Demo
  • ✅ Up-to-date dependencies
  • ✅ Docusaurus v2
  • ✅ Modern UI: Soft UI Design, Dark-Mode
  • ✅ Versioned Content
  • ✅ MIT License, Free Support
  • ℹ️ SSR (coming soon)
  • ℹ️ 404 Events Reporting EmailJS (coming soon)

Docusaurus Soft UI Design - Open-source DOCS Starter.


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

Links & Resources

Docusaurus Soft Design - Free DOCS Starter provided by AppSeed.