README.md

Build a documentation site with Weminal Template using Nextra

You can view at Readme File or Notion Site to gain this knowledge

1. What is Nextra?

According to Nextra.site, Nextra is a framework on top of Next.js that lets you build content-focused websites. It has all the great features from Next.js, plus extra power to create Markdown-based content with ease.

You can read about Nextra here: More about Nextra.

With Nextra, you can create a full-blown documentation site with search functionality, syntax highlighting, embedding React components into MDX files, and more.

Some companies that use Nextra for their documentation sites include Next.js, React, Tailwind, Node.js, CodeSandbox and more.

2. Features of Nextra

• Light and dark mode theme.
• Advanced syntax highlighting for code snippets.
• Ability to use React components in markdown files.
• Full-text search functionality.

3. Getting Started With Weminal Document Template

A ready-made template for a documentation site is available on Weminal’s template repository. So you have to create the repository from this template.

Now, in Weminal’s template repository, click button Use this template:

You need to fill some necessary information like this:

Repository was created!

You can clone this repository into your local machine by

git clone your_repo

Once you've cloned the git repository on your machine, you should have a folder structure like this:

Now that you've cloned the repository navigate into the project directory and install the dependencies:

npm install

When the installation is complete, start the local development server by running the following:

npm run dev

🎉 Tada! You done 🎉