Giter VIP home page Giter VIP logo

docs-theme's Introduction

Nextra

Nextra is a Next.js plugin that renders your MDX files with custom themes.

Development

Installation

The Nextra repository uses PNPM Workspaces and Lerna. To install dependencies, just simply run pnpm in the project root directory.

Build Nextra Core

cd packages/nextra
pnpm build

Watch mode: yarn dev

Build Nextra Theme

cd packages/nextra-theme-docs
pnpm build

Watch mode: pnpm dev Watch mode (layout only): pnpm dev:layout Watch mode (style only): pnpm dev:tailwind

Development

You can also debug them together with a website locally. For instance, to start examples/docs locally, run

cd examples/docs
pnpm dev

Any change to example/docs will be re-rendered instantly.

If you update the core or theme packages, a rebuild is required. Or you can use the watch mode for both nextra and the theme in separated terminals.

docs-theme's People

Contributors

amagiddmxh avatar azproductions avatar benoror avatar brooooooklyn avatar chinw avatar davesnx avatar djyde avatar dzearing avatar geekplux avatar gr-qft avatar jaredpalmer avatar joostory avatar jrvidal avatar leerob avatar madmanwithabike avatar maltejur avatar mannybecerra avatar marcosrjjunior avatar navin-moorthy avatar neighborhood999 avatar nguyenvukhang avatar olmesm avatar pacocoursey avatar promer94 avatar robbear avatar rot1024 avatar shuding avatar sinchang avatar surjithctly avatar thien-do 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.