Vnote Documentation Release 1.11.1
Total Page:16
File Type:pdf, Size:1020Kb
VNote Documentation Release 1.11.1 Le Tan Feb 13, 2019 User Documentation 1 Why VNote 3 1.1 What is VNote..............................................3 1.2 Why Another Markdown Wheel.....................................3 2 Getting Started 5 2.1 Main Interface..............................................5 2.2 Ready To Go...............................................7 3 Build VNote 9 3.1 Get the Source Code of VNote......................................9 3.2 Get Qt 5.9................................................9 3.3 Windows.................................................9 3.4 Linux...................................................9 3.5 MacOS.................................................. 10 4 Notes Management 13 4.1 Notebook................................................. 13 4.2 Folders.................................................. 14 4.3 Notes................................................... 14 5 Snippet 15 5.1 Snippet Management........................................... 15 5.2 Define A Snippet............................................. 16 5.3 Apply A Snippet............................................. 16 5.4 Examples................................................. 16 6 Magic Word 19 6.1 Built-In Magic Words.......................................... 19 6.2 Custom Magic Words.......................................... 20 6.3 Magic Word In Snippet.......................................... 21 7 Template 23 8 Themes and Styles 25 8.1 Themes.................................................. 25 8.2 Editor Styles............................................... 30 8.3 Rendering Styles............................................. 32 i 8.4 Code Block Rendering Styles...................................... 33 9 Export 35 9.1 Sources.................................................. 36 9.2 Options.................................................. 37 9.3 Formats.................................................. 37 10 Full-Text Search 41 10.1 Keywords................................................. 42 10.2 Scope................................................... 42 10.3 Object.................................................. 42 10.4 Target................................................... 42 10.5 File Pattern................................................ 42 11 Frequently Asked Questions 43 11.1 How to specify customized MathJax script?............................... 43 11.2 How to make VNote more “portable”?................................. 44 11.3 How to draw diagrams using Mermaid or Flowchart.js?........................ 44 11.4 How to open a note in another tab?................................... 45 11.5 Interface is freezed............................................ 46 11.6 Cursor is not visible in edit mode.................................... 46 11.7 Crash when opening a note........................................ 46 11.8 Menu does not work in fullscreen mode................................. 46 ii VNote Documentation, Release 1.11.1 Designed specially for Markdown, VNote is a Vim-inspired note-taking application, which knows programmers and Markdown better. VNote is open source, and available on Github. There are documents in several languages. • English • Simplified Chinese() • Japanese() The main documentation for the site is organized into a couple of sections: • User Documentation • Advanced Documentation • Developer Documentation • About VNote User Documentation 1 VNote Documentation, Release 1.11.1 2 User Documentation CHAPTER 1 Why VNote 1.1 What is VNote VNote is a Vim-inspired Note-taking application, designed specially for Markdown. It is not yet just another Mark- down editor. VNote is designed to be a powerful Markdown editor with sweet note management, or a note-taking application with pleasant Markdown experience. VNote is free, and open source. You could get VNote for Linux, Windows, and macOS. 1.2 Why Another Markdown Wheel 1.2.1 Insights About Markdown Markdown, as a simple mark language, unlike rich text, was born with a gap between edit and read. There are about three ways to handle this gap: 1. As one extreme, some editors just treat Markdown as plain text. Users may lose themselves in the messy black characters. It is hard to keep track of the information of the note. 2. Most Markdown editors use two side-by-side panels to edit and preview Markdown notes simultaneously. It makes things easier since users could see a pleasant typesetting and layout while editing the text. However, two panels may occupy the whole screen and users keep moving eyes left and right, which will be a big distraction. 3. As another extreme, some editors convert the Markdown elements in place immediately after the typing, which makes editing Markdown just like editing rich text document in Word with some shortcuts. This may conflict with what Markdown is intended to be. Since most editors choose the second way to handle the gap, people always think of preview when it comes to Mark- down. It may be a MISUNDERSTANDING about Markdown. Designed as a simple mark language, Markdown is intended to help to keep track of the information of the text when editing and provide a beautiful typesetting when reading after being converted to HTML. 3 VNote Documentation, Release 1.11.1 1.2.2 Tradeoff: VNote’s Way VNote tries to minimize the gap and provide the best-effort WYSIWYG for Markdown via tuned syntax highlights and some other features. By helping to keep track of the content, there is no need to preview or alter the text immediately after being typed. 4 Chapter 1. Why VNote CHAPTER 2 Getting Started VNote is distributed on Linux, Windows, and macOS. You could always download standalone packages from the Downloads page. It is recommended to download and use the stable releases of VNote. If you prefer to use some latest features of VNote, you could try the latest continuous build from master branch. Besides the standalone packages, some package managers may already package and distribute VNote, such as AUR, and homebrew cask. 2.1 Main Interface Here is a snapshot of VNote’s main interface. 5 VNote Documentation, Release 1.11.1 2.1.1 Menubar and Toolbar VNote provides some settings via Menubar at the top of the window and provides some handy shortcuts via Toolbar right below the menubar. Place mouse over the menu item or button, there is a tooltip or status tip to help illustrating the function of that item or button. 2.1.2 Notebooks, Folders, and Notes VNote uses Notebooks, Folders, and Notes hierarchy for note management. The left-side panel is used to navigate through your notebooks, folders, and notes. At the first time you launch VNote, you will be prompted to create your first notebook. A notebook corresponds to a directory in your file system. You should choose an empty directory as your Notebook Root Folder. All the contents of this notebook will be stored whthin the Notebook Root Folder. Once you have a notebook, you could create folders in this notebook. VNote supports infinite levels of folders. The bottom panel at the left side will list all the notes of current folder. You could create a new note via the context menu. 2.1.3 Content Area The middle area which occupies most of the space is the Content Area, which is used to read and edit notes. VNote supports opening multiple notes by tabs. 6 Chapter 2. Getting Started VNote Documentation, Release 1.11.1 2.1.4 Tools Dock Widget At the right-side panel, there are multiple tools to facilitate your reading and editing, such as Outline and Snippets. 2.2 Ready To Go That is it! Now you could read, edit, and mange your notes in VNote! 2.2. Ready To Go 7 VNote Documentation, Release 1.11.1 8 Chapter 2. Getting Started CHAPTER 3 Build VNote You need Qt 5.9 to build VNote from source. 3.1 Get the Source Code of VNote VNote’s source code is available on Github. You could download the ZIP archive of the code. Please be aware of that VNote depends on some submodules, so you should also download the source codes of these modules. The recommended way is using git like this: git clone https://github.com/tamlok/vnote.git vnote.git cd vnote.git git submodule update--init 3.2 Get Qt 5.9 You could get the standalone Qt SDK from Qt Downloads. For users in China, you could speed up the download via the TUNA Mirrors. 3.3 Windows On Windows, you need Visual Studio 2015 or above to compile VNote. Open Qt Creator and open vnote.git\VNote.pro as project. Now you are ready to tune and compile VNote! 3.4 Linux In Ubuntu, you could get Qt 5.9 from PPA like this: 9 VNote Documentation, Release 1.11.1 sudo add-apt-repository ppa:beineri/opt-qt591-trusty -y sudo apt-get update -qq sudo apt-get -y install qt59base qt59webengine sudo apt-get -y install qt59webchannel qt59svg qt59location qt59tools qt59translations source /opt/qt*/bin/qt*-env.sh Then compile and install VNote like this: cd vnote.git mkdir build cd build qmake ../VNote.pro make sudo make install 3.4.1 Fcitx If you use Fcitx as the input method, you need to copy the missing library libfcitxplatforminputcontextplugin.so to Qt’s plugin directory. To find the place of libfcitxplatforminputcontextplugin.so, you could execute: fcitx-diagnose | grep libfcitxplatforminputcontextplugin.so If there is no such lib, you may need to install and configure Fcitx for Qt5 correctly before continue. Then you need to copy the lib to Qt’s plugin directory: <path_to_Qt_installation_directory>/5.9.3/gcc_64/plugins/platforminputcontexts/ 3.4.2 OpenSSL VNote needs openSSL 1.0 for networking. To verify if it has been setup correctly, you could check for updates