Skip to content

namnguyenthanhwork/docusaurus-material-ui-template

Repository files navigation

Integrating Docusaurus with Material UI Template

This project is a Docusaurus website integrated with Material UI. Docusaurus is a modern static website generator that makes it easy to build personal, project, and organization sites. Material UI is a popular React UI framework that provides a set of reusable, well-tested, and accessible UI components.

View Demo →

Technology used

  • Docusaurus V3
  • Material UI
  • Search engine: @easyops-cn/docusaurus-search-local

Features

The project uses the @easyops-cn/docusaurus-search-local plugin for local search functionality. This plugin provides full-text search over your Docusaurus site, without needing to rely on any external services. It supports indexing of pages and documents, and even supports language-specific searching.

The website also features a new blog UI was built using Material UI components and provides a modern, clean interface for displaying blog posts. The blog posts are managed by a custom blog plugin, defined in src/plugins/blog-plugin.js and homepage config in components/Homepage/index.js.

Start your project

Deploy on Vercel

You can get started by creating your own Docusaurus website and deploy to Vercel by clicking the link:

Vercel will copy the Docusaurus Material UI and deploy the website for you. Once completed, every commit in the repo will be deployed automatically.

Installation

Clone the repository

Open project and install packages

npm i

Ready to use

Start the development server

npm start

Build the project

npm run build

Contributing to the project

Create a new Pull Request to contribute to the project. If you find any issues or have suggestions for improvements, please create a new issue. Thanks for any feedback!