Code Monkey home page Code Monkey logo

docusaurus-soft-design's Introduction

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


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

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

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


Docusaurus Soft Design - Free DOCS Starter provided by AppSeed.

docusaurus-soft-design's People

Contributors

app-generator avatar onattech avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

docusaurus-soft-design's Issues

Features

This project should provide:

The goal of this project is to help developers to start fast a new DOCS project using a cool design.

Ty!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.