Skip to content

mingfengwan/mdbootstrap-academic

Repository files navigation

Features

Brand-new designs for Course Work, Publication, and Academic Service sections.

Course Work Section Screenshot
Course Work Section
Publication Section Screenshot
Publication Section
Service Section Screenshot
Service Section

This template exhibits superior performance even after incorporating a large-sized WebP file.

Google Lighthouse Screenshot
Google Lighthouse Screenshot


Usage

If you don't need any customization, simply download index.html and main.js from the distribution folder and modify contents in index.html. Make sure to place both files in the same folder. Webpack is only needed if you want further customization.

Color Scheme

Please follow the color scheme for MDBootstrap when changing or adding colors.

Webpack

Installation

npm install

A free version of MDB UI Kit and a paid version of Font Awesome are already included as a dependencies, in package.json. Upgrade to paid or downgrade to free as you like.

Dev Server

npm run start

Build

npm run build

Features:

Files structure:

mdbootstrap-academic/
├── dist/
│   └── index.html
├── src/
│   ├── js/
│   └── scss/
├── webpack.config.js
└── package.json

MDB UI KIT

Importing JS modules

You can import the entire library or just individual modules:

import * as mdb from 'mdb-ui-kit'; // lib
import { Input } from 'mdb-ui-kit'; // module
import { Input as CustomInput } from 'mdb-ui-kit'; // module with custom name

In this project, I imported Collapse, Tooltip, Ripple, Carousel. You can remove Tooltip and Carousel if you are not using these UI components.

Importing CSS file

To import MDB stylesheet please use the following syntax:

@import '~mdb-ui-kit/css/mdb.min.css';