Skip to content
Fivim Docs

Getting started

Setup wizard

  • Choose a theme
  • Set password, which will be used for file encryption (including configuration files and user requested encrypted files) and unlocking login interface
  • Set the extension of the encrypted file, defaults .enc.

File types

Supports Markdown files (.md), Rich Text files (.xrtm), source files, PDFs, images, etc.

If your document content is relatively simple, it is recommended to use a markdown file. If your document content includes font color, background color, table, etc., it is recommended to use a rich text file(.xrtm).

Markdown file(.md)

Currently, using source code mode to open a markdown file, you can open the preview bar and format the markdown code.

Rich Text files(.xrtm)

We use ‘.xrtm’ as the extension for rich text files, which is essentially HTML code with strong universality and facilitates data migration

Why is it recommended to use xrtm files?

Hot key

Hot keys similar to markdown
  • Heading 1: #
  • Heading 2: ##
  • Heading 3: ###
  • Heading 4: ####
  • Heading 5: #####
  • Heading 6: ######
  • Italic: _
  • Bold: **
  • Separator line: ***
  • Ordered list: 1
  • Unordered list: -
  • Qoute: >
  • Code block: ```
  • Table: |||
  • Link: [
  • Image: !

Usage: Press the shortcut key in the new block, then press shift + space to trigger the shortcut function

Other hot keys
  • ctrl + s: save file
  • ctrl + f: find
  • ctrl + h: replace
  • ctrl + b: bold
  • ctrl + u: underline
  • ctrl + i: italic
  • alt + p: remove format
  • alt + 0: toggle to normal text
  • alt + 1: toggle heading 1
  • alt + 2: toggle heading 2
  • alt + 3: toggle heading 3
  • alt + 4: toggle heading 4
  • alt + 5: toggle heading 5
  • alt + 6: toggle heading 6
  • alt + 7: insert ordered list
  • alt + 8: insert unordered list

Source code file

Provides code highlighting for common programming languages. Including: c / c++ / c# / css / go / html / java / javascript / php / python / rust / ruby etc.

Supports editing in rich text’s code blocks, as well as directly opening source code files.

Sync

Currently supports Gitee and Gitlab. If synchronization is enabled, file changes will first modify remote files before modifying local files.

The token needs to be obtained by the user on the Gitee and Gitlab pages:

gitee’s token At least check the Permission projects.

gitlab’s token At least check the Scopes api, read_api, read_repository, write_repository.

Configuration file

Fivim has two configuration files located in the fivim directory in your document directory:

  • conf/conf. bin is the main configuration file, and its content will be encrypted.
  • conf/conf. startup. json is the configuration file for launching the app, and its content is json

The specific path for conf/conf.bin is:

  • Windows: C:\Users\YOUR_USER_NAME\Documents\fivim\conf.bin
  • Linux: ~/Documents/fivim/conf/conf.bin
  • MacOS: ~/Documents/fivim/conf/conf.bin