|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 1 | +# MathStudio |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +**A professional Markdown editor designed for mathematics and coding.** |
| 4 | + |
| 5 | +[**🚀 Live Demo / 在线体验**](https://matrixcqy.github.io/traeweb1/) |
4 | 6 |
|
5 | | -First, run the development server: |
| 7 | + |
| 8 | +*(Note: You can add a screenshot here later)* |
6 | 9 |
|
7 | | -```bash |
8 | | -npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | | -# or |
14 | | -bun dev |
15 | | -``` |
| 10 | +## Features |
16 | 11 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 12 | +- **LaTeX Support**: Write mathematical formulas easily with inline `$E=mc^2$` or block syntax. |
| 13 | +- **Code Highlighting**: Syntax highlighting for various programming languages. |
| 14 | +- **VS Code Style**: A clean, professional editing experience with dark mode support. |
| 15 | +- **Live Preview**: Real-time rendering of your Markdown content. |
| 16 | +- **File Management**: |
| 17 | + - Virtual file system (files/folders) persisted in browser. |
| 18 | + - Search functionality. |
| 19 | + - Import/Export capability (download `.md` files). |
| 20 | +- **Responsive Design**: Works on desktop, tablets, and mobile devices (with split-view support). |
| 21 | + |
| 22 | +## Getting Started |
18 | 23 |
|
19 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 24 | +To run this project locally: |
20 | 25 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 26 | +1. Clone the repository: |
| 27 | + ```bash |
| 28 | + git clone https://github.com/MatrixCQY/traeweb1.git |
| 29 | + ``` |
22 | 30 |
|
23 | | -## Learn More |
| 31 | +2. Install dependencies: |
| 32 | + ```bash |
| 33 | + npm install |
| 34 | + # or |
| 35 | + yarn install |
| 36 | + ``` |
24 | 37 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 38 | +3. Run the development server: |
| 39 | + ```bash |
| 40 | + npm run dev |
| 41 | + ``` |
26 | 42 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 43 | +4. Open [http://localhost:3000](http://localhost:3000) with your browser. |
29 | 44 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 45 | +## Deployment |
31 | 46 |
|
32 | | -## Deploy on Vercel |
| 47 | +This project is automatically deployed to GitHub Pages using GitHub Actions. |
33 | 48 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 49 | +## Tech Stack |
35 | 50 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 51 | +- **Framework**: [Next.js](https://nextjs.org) (App Router) |
| 52 | +- **Styling**: [Tailwind CSS v4](https://tailwindcss.com) |
| 53 | +- **Editor**: [Monaco Editor](https://microsoft.github.io/monaco-editor/) |
| 54 | +- **Markdown**: `react-markdown`, `remark-math`, `rehype-katex`, `rehype-highlight` |
| 55 | +- **Icons**: [Lucide React](https://lucide.dev) |
0 commit comments