加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

克隆/下载

BUILD.md 1.73 KB

# Build Instructions

Clone the repository:

```
git clone https://github.com/marktext/marktext.git
```

### Prerequisites

Before you can get started developing, you need set up your build environment:

- Node.js `>=v14` and yarn
- Python `>=v3.6` for node-gyp
- C++ compiler and development tools
- Build is supported on Linux, macOS and Windows

**Additional development dependencies on Linux:**

- libx11 (dev)
- libxkbfile (dev)
- libsecret (dev)
- libfontconfig (dev)

On Debian-based Linux: `sudo apt-get install libx11-dev libxkbfile-dev libsecret-1-dev libfontconfig-dev`

On Red Hat-based Linux: `sudo dnf install libx11-devel libxkbfile-devel libsecret-devel fontconfig-devel`

**Additional development dependencies on Windows:**

- Windows 10 SDK (only needed before Windows 10)
- Visual Studio 2019 (prefered)

### Let's build

1. Go to `marktext` folder
2. Install dependencies: `yarn install` or `yarn install --frozen-lockfile`
3. Build Mark Text binaries and packages: `yarn run build`
4. Mark Text binary is located under `build` folder

Copy the build app to applications folder, or if on Windows run the executable installer.

### Important scripts

```
$ yarn run <script> # or npm run <script>
```

| Script          | Description                                       |
| --------------- | ------------------------------------------------- |
| `build`         | Build Mark Text binaries and packages for your OS |
| `build:bin`     | Build Mark Text binary for your OS                |
| `dev`           | Build and run Mark Text in developer mode         |
| `lint`          | Lint code style                                   |
| `test` / `unit` | Run unit tests                                    |

For more scripts please see `package.json`.

一键复制编辑原始数据按行查看历史

提交于 2021-12-05 16:27 . Update actions and enable Windows pipeline (#2727)

Build Instructions

Clone the repository:

git clone https://github.com/marktext/marktext.git

Prerequisites

Before you can get started developing, you need set up your build environment:

Node.js >=v14 and yarn
Python >=v3.6 for node-gyp
C++ compiler and development tools
Build is supported on Linux, macOS and Windows

Additional development dependencies on Linux:

libx11 (dev)
libxkbfile (dev)
libsecret (dev)
libfontconfig (dev)

On Debian-based Linux: sudo apt-get install libx11-dev libxkbfile-dev libsecret-1-dev libfontconfig-dev

On Red Hat-based Linux: sudo dnf install libx11-devel libxkbfile-devel libsecret-devel fontconfig-devel

Additional development dependencies on Windows:

Windows 10 SDK (only needed before Windows 10)
Visual Studio 2019 (prefered)

Let's build

Go to marktext folder
Install dependencies: yarn install or yarn install --frozen-lockfile
Build Mark Text binaries and packages: yarn run build
Mark Text binary is located under build folder

Copy the build app to applications folder, or if on Windows run the executable installer.

Important scripts

$ yarn run <script> # or npm run <script>

Script	Description
`build`	Build Mark Text binaries and packages for your OS
`build:bin`	Build Mark Text binary for your OS
`dev`	Build and run Mark Text in developer mode
`lint`	Lint code style
`test` / `unit`	Run unit tests

For more scripts please see package.json.

NodeJS

1

https://gitee.com/thepoy/marktext.git

git@gitee.com:thepoy/marktext.git

thepoy

marktext

marktext

develop