Nextra 2 – Next.js Static Site Generator

#### Markdown Import

In case of reusing some duplicated content you can export and import your markdown files.



```mdx filename="task-list.mdx"
- [x] Code
- [x] Sleep
- [ ] Eat

### Support Next.js 13

Nextra 2 comes with support for the latest **Next.js 13** version and also up to Next.js 9!

### Images and Links Optimization

Static images are always optimized with `` component, internal links are replaced with
`` component, external links will have `target="_blank"` and `rel="noreferrer"` and will
inform screen readers about opening a link in a new tab.

`` will prevent to have layout shifts on your page. Instantiate (client-side)
navigation would be done with ``.



```text filename="Markdown"
![Hero](/hero.png)
[Learn more](/more)
[See examples](https://github.com/shuding/nextra/tree/main/examples)

import Image from 'next/image'
import Link from 'next/link'
import nextraImage from '../../public/hero.png'

function MDXContent() {
  return (
    <>
      <Image src={nextraImage} alt="Hero" />
      <Link href="https://dev.to/more">Learn moreLink>
      <a
        href="https://github.com/shuding/nextra/tree/main/examples"
        target="_blank"
        rel="noreferrer"
      >
        See examples<span className="sr-only"> (opens in a new tab)span>
      a>
    
  )
}

export default MDXContent

### Remote Markdown

Rendering remote markdown is simple, you will need:

1.  Install `next-mdx-remote` and import `MDXRemote` component
2.  Compile your markdown raw string using `compileMdx` from `nextra/compile` in `getStaticProps()`
3.  Provide your compiled result code to `props.ssg`
4.  Get data from SSG with `useSSG` hook from `nextra/ssg`
5.  Provide compiled result code for `MDXRemote` via `compiledSource` prop
6.  Provide `components` from `useMDXComponents` hook from `nextra/mdx` for `MDXRemote` to prevent layout shifts



```mdx filename="Remote Nextra Readme" showLineNumbers {1,9,12,20,22}
import { MDXRemote } from 'next-mdx-remote' {/* 1 */}
import { compileMdx } from 'nextra/compile'
import { useSSG } from 'nextra/ssg'
import { useMDXComponents } from 'nextra/mdx'

export const getStaticProps = async () => {
  const response = await fetch('https://raw.githubusercontent.com/shuding/nextra/main/README.md')
  const markdown = await response.text()
  const mdx = await compileMdx(markdown, { defaultShowCopyCode: true }) // 2
  return {
    props: {
      ssg: mdx.result // 3
    },
    // Revalidate at most once every 1 hour
    revalidate: 60 * 60
  }
}

export const NextraReadme = () => {
  const compiledSource = useSSG() // 4
  const components = useMDXComponents()
  return  // 5-6
}

jsx filename="My File" showLineNumbers /App/ {2}
function App() {
  return 
Hello
}

`

will be rendered as:

```jsx filename="My File" showLineNumbers /App/ {2}
function App() {
  return 
Hello
}
```

#### Next SEO Builtin

Out of the box, `nextra-theme-docs` has Next SEO installed. By default, in the front matter you can
set `title`, `description`, `canonical` and `openGraph` and they will be passed directly to the
`` component.

```md filename="Markdown"
---
title: "Nextra 2"
description: "Nextra – Next.js Static Site Generator"
---
```

will be passed to Next SEO and rendered on the page as:

```html

  
  
  
  

```


  You can manually pass Next SEO props with `useNextSeoProps` theme option. [Read
  more](https://nextra.site/docs/docs-theme/theme-configuration#seo-options) in the docs.


#### I18n Support

`nextra-theme-docs` comes with support i18n in your website.

To use it, provide Next.js' `i18n` field with `locales` and `defaultLocale` setup:

```js filename="next.config.js"
export default withNextra({
  i18n: {
    locales: ['en-US', 'fr-FR'],
    defaultLocale: 'en-US'
  }
})
```

Add Nextra's middleware:

```js filename="middleware.js"
export { locales as middleware } from 'nextra/locales'
```

Create your `_meta` and page files with locales suffixes:

```text
├── pages
│   ├── _meta.en-US.json
│   ├── _meta.fr-FR.json
│   ├── index.en-US.mdx
│   ├── index.fr-FR.mdx
```

```mdx filename="index.en-US.mdx"
# 🇺🇸 Hello Nextra 2
```

```mdx filename="index.fr-FR.mdx"
# 🇫🇷 Bonjour Nextra 2
```

[Learn more](https://nextra.site/docs/guide/i18n) on docs.

#### LTR/RTL Direction Support

Your website can be fully mirrored with RTL direction. All that you need it provides `dir: 'rtl'` in
your `theme.config.jsx` file.



#### A11y

Accessibility is all, Nextra respects system preferences, animation will be reduced with
`reduce-motion` mode, colors will be adjusted in `contrast-more` mode.



## Conclusion

[The Guild](/) discovered Nextra 2 from the first betas and actively participated in the development
and improvement of this library. I (Dimitri) become
[an official maintainer](https://nextra.site/about#team) of this library on par with Nextra creator
amazing [Shu Ding](https://github.com/shuding/nextra) from Vercel.

In the end, we migrated all our projects' documentation to Nextra, which provides a better setup and
documentation design than our previous `guild-docs` package. Alongside we added Giscus comments at
the end of each page that synchronizes with GitHub discussions.

We receive a bunch of positive feedback and much more contributions and fixing mistakes in our docs
from our community ❤️.

In fact, even this blog uses Nextra 2 and `nextra-theme-docs`. 👀