npmpackage.info

Gathering detailed insights and metrics for @visulima/nextra-theme-docs

@visulima/nextra-theme-docs - 4.0.26 | npmpackage.info

@visulima/nextra-theme-docs

Visulima is the next-gen JavaScript framework for JAMStack blogs, sites & apps.

4.0.26

MIT

TypeScript

740.12 kB

6.2

Installations

npm install @visulima/nextra-theme-docs

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=18.* <=22.*

Node Version

18.20.3

NPM Version

9.6.7 Pull Requests

Open

6

Total

490

Closed

154

Merged

330

Issues

Open

5

Total

19

Closed

14

Releases

1,252

@visulima/cerebro@1.1.46

Updated on Jun 04, 2025

@visulima/boxen@2.0.2

Updated on Jun 04, 2025

@visulima/pail@2.1.25

Updated on Jun 04, 2025

@visulima/api-platform@3.0.44

Updated on Jun 04, 2025

@visulima/jsdoc-open-api@2.0.81

Updated on Jun 04, 2025

@visulima/find-cache-dir@1.0.31

Updated on Jun 04, 2025

View All 1,252 releases

Languages

TypeScript

JavaScript

MDX

Handlebars

Shell

CSS

TypeScript (93.51%)

JavaScript (5.17%)

MDX (1.02%)

Handlebars (0.14%)

Shell (0.08%)

CSS (0.08%)

Developer

visulima

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

16 Stars

2,703 Commits

3 Forks

2 Watchers

17 Branches

2 Contributors

Updated on Jun 10, 2025

Sponsor this package

https://github.com/sponsors/prisis https://anolilab.com/support

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

4.0.26

Package Id

@visulima/nextra-theme-docs@4.0.26

Unpacked Size

740.12 kB

Size

157.21 kB

File Count

NPM Version

9.6.7

Node Version

18.20.3

Published on

Jun 06, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

next nextra react react-dom zod

Dev Dependencies

@anolilab/eslint-config @anolilab/prettier-config @anolilab/semantic-release-pnpm @anolilab/semantic-release-preset @arthurgeron/eslint-plugin-react-usememo @babel/core @mdx-js/react @rushstack/eslint-plugin-security @secretlint/secretlint-rule-preset-recommend @tailwindcss/nesting @tailwindcss/typography @testing-library/react @total-typescript/ts-reset @types/flexsearch @types/git-url-parse @types/he @types/micromatch @types/node @types/react @types/react-dom @vitest/coverage-v8 @vitest/ui concurrently cross-env csstype eslint eslint-plugin-deprecation eslint-plugin-etc eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-mdx eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-ssr-friendly eslint-plugin-testing-library eslint-plugin-validate-jsx-nesting eslint-plugin-vitest eslint-plugin-vitest-globals eslint-plugin-zod jsdom lightningcss-cli next nextra postcss postcss-cli postcss-focus-visible postcss-import postcss-lightningcss prettier react react-dom rimraf rxjs semantic-release tailwindcss tailwindcss-hyphens tsup typescript vitest zod

Visulima nextra-theme-docs

Nextra Docs Theme is a theme that includes almost everything you need to build a modern documentation website. It includes a top navigation bar, a search bar, a pages sidebar, a TOC sidebar, and other built-in components.
Visulima nextra-theme-doc is built on top of

Nextra, Tailwind CSS, Next.js, giscus, react-hot-toast,

^{Daniel Bannert's open source work is supported by the community on GitHub Sponsors}

Look and feel

Install

If you have a Nextra project, you can install the theme with:

1npm install @visulima/nextra-theme-docs zod

1yarn add @visulima/nextra-theme-docs zod

1pnpm add @visulima/nextra-theme-docs zod

if you don't have a Nextra project, you can use the Next CLI to create one and install

1npm install nextra @visulima/nextra-theme-docs zod

1yarn add nextra @visulima/nextra-theme-docs zod

1pnpm add nextra @visulima/nextra-theme-docs zod

Add Next.js Config

If not there create the following next.config.js file in your project’s root directory:

1const withNextra = require("nextra")({
2    theme: "@visulima/nextra-theme-docs",
3    themeConfig: "./theme.config.jsx",
4});
5
6module.exports = withNextra();
7
8// If you have other Next.js configurations, you can pass them as the parameter:
9// module.exports = withNextra({ /* other next.js config */ })

Add Css style to your `pages/_app.{jsx,tsx,mdx}` file

1import "@visulima/nextra-theme-docs/style";
2
3import type { AppProps } from "next/app";
4import Head from "next/head";
5import type { FC, ReactElement } from "react";
6import React from "react";
7
8const MyApp: FC<AppProps & { Component: AppProps["Component"] & { getLayout?: (component: ReactElement) => ReactElement } }> = ({ Component, pageProps }) => {
9    const getLayout: (component: ReactElement) => ReactElement = Component.getLayout ?? ((page) => page);
10
11    return (
12        <>
13            <Head>
14                <link as="font" crossOrigin="anonymous" href="/Inter.var.woff2" rel="preload" type="font/woff2" />
15            </Head>
16            {/* eslint-disable-next-line react/jsx-props-no-spreading */}
17            {getLayout(<Component {...pageProps} />)}
18        </>
19    );
20};
21
22export default MyApp;
23

Add `SkipNavLink` component your `pages/_document.{jsx,tsx,mdx}` file

1import { SkipNavLink } from "@visulima/nextra-theme-docs/components";
2import Document, { Head, Html, Main, NextScript } from "next/document";
3import type { ReactElement } from "react";
4import React from "react";
5
6class MyDocument extends Document {
7    public render(): ReactElement {
8        return (
9            <Html lang="en">
10                <Head />
11                <body className="relative">
12                    <SkipNavLink />
13                    <Main />
14                    <NextScript />
15                </body>
16            </Html>
17        );
18    }
19}
20
21export default MyDocument;
22

Create Docs Theme Config

Lastly, create the corresponding theme.config.jsx file in your project’s root directory. This will be used to configure the Nextra Docs theme:

1export default {
2    logo: <span>My Nextra Documentation</span>,
3    project: {
4        link: "https://github.com/shuding/nextra",
5    },
6    // ...
7};

Ready to Go!

Now, you can create your first MDX page as pages/index.mdx:

1## Welcome to Nextra
2
3Hello, world!

For more information, check out the Nextra documentation. You can also check the example project here.

Supported Node.js Versions

Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.

Contributing

If you would like to help take a look at the list of issues and check our Contributing guild.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

License

The visulima nextra-theme-docs is open-sourced software licensed under the MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Contributors

Determines if the project has a set of contributors from multiple organizations (e.g., companies).

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

License

Determines if the project has defined a license.

10

Maintained

Determines if the project is "actively maintained".

10

SAST

Determines if the project uses static code analysis.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

Reason

detected GitHub workflow tokens with excessive permissions

Details

Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:33
Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:34
Warn: jobLevel 'contents' permission set to 'write': .github/workflows/lock-file-maintenance.yml:20
Warn: jobLevel 'contents' permission set to 'write': .github/workflows/preview-release.yaml:22
Warn: jobLevel 'checks' permission set to 'write': .github/workflows/preview-release.yaml:24
Info: jobLevel 'pull-requests' permission set to 'read': .github/workflows/require-allow-edits.yml:11
Info: jobLevel 'contents' permission set to 'read': .github/workflows/scorecards.yml:31
Info: jobLevel 'actions' permission set to 'read': .github/workflows/scorecards.yml:32
Warn: jobLevel 'statuses' permission set to 'write': .github/workflows/semantic-pull-request.yml:21
Warn: no topLevel permission defined: .github/workflows/allo-allo.yaml:1
Warn: no topLevel permission defined: .github/workflows/cache-clear.yml:1
Info: topLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:24
Info: topLevel 'contents' permission set to 'read': .github/workflows/comment-issue.yml:9
Info: topLevel 'contents' permission set to 'read': .github/workflows/dependency-review.yml:17
Warn: no topLevel permission defined: .github/workflows/labeler.yml:1
Info: topLevel 'contents' permission set to 'read': .github/workflows/lint.yml:16
Info: topLevel 'contents' permission set to 'read': .github/workflows/lock-file-maintenance.yml:12
Warn: no topLevel permission defined: .github/workflows/lock-issues.yaml:1
Info: topLevel 'contents' permission set to 'read': .github/workflows/preview-release.yaml:8
Info: topLevel 'contents' permission set to 'read': .github/workflows/require-allow-edits.yml:6
Info: topLevel permissions set to 'read-all': .github/workflows/scorecards.yml:20
Info: topLevel 'contents' permission set to 'read': .github/workflows/semantic-pull-request.yml:15
Info: topLevel 'contents' permission set to 'read': .github/workflows/semantic-release.yml:17
Warn: no topLevel permission defined: .github/workflows/stale-issues.yml:1
Info: topLevel 'contents' permission set to 'read': .github/workflows/test.yml:16

Score

6.2

/10

Last Scanned on 2025-07-08T07:32:37Z

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@visulima/nextra-theme-docs

Installations

Developer Guide

Yes

ESM

>=18.* <=22.*

18.20.3

9.6.7

Pull Requests

6

490

154

330

Issues

5

19

14

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Visulima nextra-theme-docs

Install

Add Next.js Config

Add Css style to your pages/_app.{jsx,tsx,mdx} file

Add SkipNavLink component your pages/_document.{jsx,tsx,mdx} file

Create Docs Theme Config

Ready to Go!

Supported Node.js Versions

Contributing

Credits

License

10

10

10

10

10

10

10

8

0

0

0

0

0

6.2

/10

Add Css style to your `pages/_app.{jsx,tsx,mdx}` file

Add `SkipNavLink` component your `pages/_document.{jsx,tsx,mdx}` file