Coder Social home page Coder Social logo

my-new's Introduction

Academic Homepage Template

This project is an academic homepage template built with Next.js, Tailwind CSS, and ShadcnUI. The design is minimalistic and modern, providing a clean and professional look for academic portfolios. It supports deployment to Zeabur and can directly parse .bib files to display publications.

screemshot

Features

  • Minimalistic Design: Clean and modern interface to showcase academic work.
  • Markdown Support: Write website content using markdown files.
  • Dark Mode: Supports dark mode for a comfortable viewing experience.
  • Responsive Design: Fully responsive and mobile-friendly.
  • Bib File Parsing: Directly parse and display publications from .bib files.

Customization

Structure

Your data is divided into three parts:

  • public folder: Stores your images and CV files.
  • data folder: Stores your MDX files and .bib files.
  • website.config.js: Contains your personal information and social media links.

MDX

We use .mdx files to write content, which is an extension of markdown files. You can use markdown syntax to write your content.

Project frontmatter

MDX files in the data/projects directory need to include frontmatter at the top in the following format:

---

title: "FibeRobo"

description: "Fabricating 4D Fiber Interfaces by Continuous Drawing of Temperature Tunable Liquid Crystal Elastomers"

date: "2023-01-01"

image: "/project1.jpg"

---

The image can be stored in the public folder.

Bib Files

Place your .bib file in the data/bib directory. The application will automatically parse the file and display your publications. Make sure to name the .bib file as Publications.bib or SelectedPublications.bib for correct parsing.

Development

Prerequisites

  • Node.js (version 14.x or higher)
  • pnpm

Installation

  1. Clone the repository

    git clone https://github.com/anxndsgn/academic-homepage-template.git
    cd academic-homepage-template
  2. Install dependencies

    Using pnpm:

    pnpm i

Development

To start the development server, run:

pnpm run dev

Open http://localhost:3000 in your browser to see the result.

Deployment

  • Sign in to Zeabur and create a new project.
  • Fork this repo.
  • Deploy the project using Git service. For more detailed instructions, refer to the Zeabur documentation.

Deployed on Zeabur

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

  • Next.js
  • Tailwind CSS
  • ShadcnUI
  • Zeabur

my-new's People

Contributors

3273828564 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.