github/marktext
5
0
Fork 0
mirror of https://github.com/marktext/marktext.git synced 2025-05-02 19:41:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation (#1819)

Browse Source
This commit is contained in:
Felix Häusler 2019-12-17 03:50:10 +01:00 committed by Ran Luo
parent dd9cc89caa
commit 09b067e371
3 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/FAQ.md
View File

@ -31,3 +31,13 @@ Yes, please see [here](../PORTABLE.md) for further information.
### How can I report bugs and problems ### How can I report bugs and problems
You can report bugs and problems via our [GitHub issue tracker](https://github.com/marktext/marktext/issues). Please provide a detailed description of the problem to better solve the issue. You can report bugs and problems via our [GitHub issue tracker](https://github.com/marktext/marktext/issues). Please provide a detailed description of the problem to better solve the issue.
### I cannot launch Mark Text on Linux (SUID sandbox)
> *The SUID sandbox helper binary was found, but is not configured correctly.*
Normally, you should never get this error but if you disabled user namespaces, this error message may appears in the command output when launching Mark Text. To solve the issue, that Chromium cannot start the sandbox (process), you can choose one of the following steps:
- Enable Linux kernel user namespaces to use the preferred sandbox: `sudo sysctl kernel.unprivileged_userns_clone=1`.
- Set correct SUID sandbox helper binary permissions: `sudo chown root <path_to_marktext_dir>/chrome-sandbox && sudo chmod 4755 <path_to_marktext_dir>/chrome-sandbox`. This is prefered if you don't want to enable user namespaces.
- Launch Mark Text with `--no-sandbox` argument.

4
docs/LINUX.md
View File

@ -12,6 +12,10 @@ Download the AppImage and type the following:
You cannot really install an AppImage. It's just a file which can be integrated with your desktop environment. The only thing you have to do is to create a desktop file that link to Mark Text (like `~/.local/share/applications/appimage-marktext.desktop`). You cannot really install an AppImage. It's just a file which can be integrated with your desktop environment. The only thing you have to do is to create a desktop file that link to Mark Text (like `~/.local/share/applications/appimage-marktext.desktop`).
##### System integration
You can integrate the AppImage into the system via AppImageLauncher.
### Uninstallation ### Uninstallation
1. Delete AppImage file. 1. Delete AppImage file.

7
docs/dev/BUILD.md
View File

@ -13,7 +13,7 @@ Before you can get started developing, you need set up your build environment:
- Node.js `>=v12.0.0` and yarn - Node.js `>=v12.0.0` and yarn
- Python `v2.7.x` for node-gyp - Python `v2.7.x` for node-gyp
- C++ compiler and development tools - C++ compiler and development tools
- Build is supported on Linux, macOS and Windows 10 - Build is supported on Linux, macOS and Windows
**Additional development dependencies on Linux:** **Additional development dependencies on Linux:**
@ -26,6 +26,11 @@ On Debian-based Linux: `sudo apt-get install libx11-dev libxkbfile-dev libsecret
On Red Hat-based Linux: `sudo dnf install libx11-devel libxkbfile-devel libsecret-devel fontconfig-devel` On Red Hat-based Linux: `sudo dnf install libx11-devel libxkbfile-devel libsecret-devel fontconfig-devel`
**Additional development dependencies on Windows:**
- Windows 10 SDK (not needed on Windows 10)
- Visual Studio 2017 (prefered)
### Let's build ### Let's build
1. Go to `marktext` folder 1. Go to `marktext` folder