Giter Club home page Giter Club logo

start-docusaurus2's Introduction

Status


Installation

Requirements

  • Node.js version >= 10.15.1
  • Yarn version >= 1.5
โฏ node -v
v12.18.4

โฏ yarn version
yarn version v1.22.10

Scaffold project website

# npx @docusaurus/init@latest init [name] [template]
npx @docusaurus/init@latest init my-website classic

Result:

Success! Created my-website
Inside that directory, you can run several commands:

  yarn start
    Starts the development server.

  yarn build
    Bundles the app into static files for production.

  yarn deploy
    Publish website to GitHub pages.

We suggest that you begin by typing:

  cd my-website
  yarn start

Happy hacking!

Running the development server

cd my-website/
yarn start

Visit http://localhost:3000/start-docusaurus2/ .

Deployment

Deploying to GitHub Pages

Modify docusaurus.config.js:

module.exports = {
  title: 'My Site',
  tagline: 'The tagline of my site',
  url: 'https://ikuokuo.github.io',
  baseUrl: '/start-docusaurus2/',
  onBrokenLinks: 'throw',
  favicon: 'img/favicon.ico',
  organizationName: 'ikuokuo',
  projectName: 'start-docusaurus2',
  ...
};

Deploy:

cd my-website/
GIT_USER=ikuokuo USE_SSH=true yarn deploy

Visit https://ikuokuo.github.io/start-docusaurus2/ .

start-docusaurus2's People

Contributors

ikuokuo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

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.