@docusaurus/utils

What is @docusaurus/utils?

@docusaurus/utils is a utility package for Docusaurus, a popular static site generator. It provides various helper functions and utilities to streamline the development and customization of Docusaurus sites.

What are @docusaurus/utils's main functionalities?

Path Utilities

This feature provides utilities for resolving and manipulating file paths, which is essential for managing the structure of a Docusaurus site.

const { resolvePathname } = require('@docusaurus/utils');
const resolvedPath = resolvePathname('/docs', '/baseUrl');
console.log(resolvedPath); // Outputs: '/baseUrl/docs'

Markdown Utilities

This feature includes functions to parse and manipulate Markdown content, which is a core part of creating documentation with Docusaurus.

const { parseMarkdownString } = require('@docusaurus/utils');
const markdownContent = '# Hello World';
const parsedContent = parseMarkdownString(markdownContent);
console.log(parsedContent); // Outputs parsed markdown content as an object

Data Normalization

This feature helps in normalizing URLs, ensuring that they are consistent and correctly formatted across the site.

const { normalizeUrl } = require('@docusaurus/utils');
const normalizedUrl = normalizeUrl(['https://example.com', 'docs']);
console.log(normalizedUrl); // Outputs: 'https://example.com/docs'

Other packages similar to @docusaurus/utils

lodash

Lodash is a modern JavaScript utility library delivering modularity, performance, and extras. It provides a wide range of utility functions for common programming tasks, similar to the utility functions provided by @docusaurus/utils but more general-purpose.

marked

Marked is a fast, lightweight Markdown parser and compiler. It is similar to the Markdown utilities provided by @docusaurus/utils but focuses solely on parsing and compiling Markdown.

path

The 'path' module in Node.js provides utilities for working with file and directory paths. It is similar to the path utilities in @docusaurus/utils but is a core module in Node.js and not specific to Docusaurus.

README

@docusaurus/utils

Node utility functions for Docusaurus packages.