github/marktext
5
0
Fork 0
mirror of https://github.com/marktext/marktext.git synced 2025-05-02 21:02:27 +08:00
Code Issues Packages Projects Releases Wiki Activity
a996defacc
marktext/docs/dev/BUILD.md
bolshoytoster 2ed5a85012
Removed the space in 'Mark Text' (#2763) (#2782) 
* Removed the space in 'Mark Text' (#2763)

Literally just replaced all occurances of 'Mark Text' with 'MarkText' using sed.

This is directly related to #2763.

* Revert changes to .github directory

Reverted changelog etc.

* Added `cs` alias for `csharp` in code blocks (Fixes #2760)

* Added error handler in the renderer process (should fix #2758)

The `src/muya/lib/contentState/clickCtrl.js` file will now return if
`document.querySelector` fails to find an element.
2021-12-25 21:05:58 +08:00

1.8 KiB
Raw Blame History

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 (with headers)
  • libxkbfile (with headers)
  • libsecret (with headers)
  • libfontconfig (with headers)

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 MarkText binaries and packages: yarn run build
  4. MarkText 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 MarkText binaries and packages for your OS
build:bin Build MarkText binary for your OS
dev Build and run MarkText in developer mode
lint Lint code style
test / unit Run unit tests

For more scripts please see package.json.