@docusaurus/preset-classic
Advanced tools
@docusaurus/preset-classic is a preset for Docusaurus, a static site generator. It provides a set of plugins and themes that help you quickly set up a documentation website with features like a blog, custom pages, and more.
Documentation
This feature allows you to set up a documentation site with a sidebar for navigation. The code sample shows how to configure the documentation plugin within the preset.
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
},
},
],
],
};Blog
This feature enables a blog section on your site. The code sample demonstrates how to configure the blog plugin to show reading time for each post.
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
blog: {
showReadingTime: true,
},
},
],
],
};Custom Pages
This feature allows you to create custom pages for your site. The code sample shows how to configure the pages plugin to use a specific directory for custom pages.
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
pages: {
path: 'src/pages',
},
},
],
],
};Theme
This feature lets you customize the theme of your site. The code sample demonstrates how to include a custom CSS file for additional styling.
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
},
],
],
};Gatsby is a React-based open-source framework for creating websites and apps. It offers a rich plugin ecosystem and is highly customizable, making it a strong alternative to Docusaurus for building static sites.
VuePress is a Vue-powered static site generator. It is designed for creating documentation and offers a simple, minimalistic approach. It is a good alternative for those who prefer Vue over React.
MkDocs is a static site generator that's geared towards project documentation. It uses Markdown for content and offers a variety of themes. It is simpler and more lightweight compared to Docusaurus.
FAQs
Classic preset for Docusaurus.
The npm package @docusaurus/preset-classic receives a total of 234,451 weekly downloads. As such, @docusaurus/preset-classic popularity was classified as popular.
We found that @docusaurus/preset-classic demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.