Skip to content

app-generator/docusaurus-soft-design

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7f96927 Β· Feb 25, 2023

History

30 Commits
Feb 18, 2023
Feb 18, 2023
Feb 25, 2023
Feb 19, 2023
Feb 25, 2023
Feb 18, 2023
Feb 18, 2023
Feb 18, 2023
Feb 25, 2023
Feb 25, 2023
Feb 25, 2023
Feb 18, 2023
Feb 25, 2023
Feb 18, 2023
Feb 18, 2023
Feb 18, 2023
Feb 18, 2023
Feb 18, 2023

Repository files navigation

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.