How to use Markdown in Secure Notes of PassXYZ, Markdown and Password Management

cover

Markdown has been used by programmers for many years. However, many people may still not know what Markdown is. As a programmer, you may know what Markdown is, but does it have anything to do with Password Management apps? In the latest version of PassXYZ, Markdown is supported as part of the Secure Notes function. In this article, we will find out what Markdown is and how to use it to make your secure notes looking similar to Microsoft Word.

What is Markdown?

In Wikipedia, the definition of Markdown is as follows:

Markdown is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

Please pay attention to the highlighted key words plain text editor. With Markdown, you can edit rich text using a plain text editor. That means you can edit contents with Markdown using any editors. This is a very useful feature in many situations. You may be wondering why we want to use Markdown with a plain text editor instead of using software like Microsoft Word to create rich text documents. There are many reasons to use Markdown. Some of them are listed below:

  1. You can edit plain text with Markdown using almost any editors. You can only use MS Word to edit Word documents. To edit rich text like Word documents, you may have to use a PC with a mouse. You don’t have this constraint to edit plain text with Markdown.
  2. It is very easy to convert Markdown to other rich text format such as HTML or MS Word etc.
  3. Markdown is super easy to use. There is not any difficulty to use it and this may be the most import reason why Markdown is so popular to be used to create online contents.

How easy to use Markdown? Please refer to the below figure. This is a comparison of the resulting look and feel of this article in the editing mode and the reading mode respectively. On the left hand side, it shows that this article was edited using Markdown in editing mode, while on the right hand side, shows the article in the reading mode.

As we can see from the picture on the left, editing text with Markdown is very similar to what we usually do when editing a document or a message. Once the edited document or message is displayed in the reading mode, the result looks fabulous indeed as shown on the right.

markdown01

Markdown Cheat Sheet

Below is a brief summary of frequently used Markdown markup. You can find more on internet by searching keyword Markdown.

markdown04

The Usage of Markdown

Initially, Markdown is a slightly formatted plain text used by programmers to add comments in the source code or to create a readme for the source code. For an example, Markdown is used extensively in GitHub for various purposes. Later on, people started to use this kind of markup to write online contents, such as blog or web page etc. Nowadays, many popular sites, such as GitHub, Bitbucket, Reddit, Stack Exchange and SourceForge use variants of Markdown to facilitate discussions between users.

Markdown and Password Management Software

PassXYZ is the first Password Management Software which provides the use of Markdown. Secure Notes is a function in almost all the Password Management software. It is a function to allow the users to take down the notes of sensitive information securely. Using plain text, it is not easy to read if the content of the note goes long without any format. With Markdown added, the readability of the Secure Notes enhanced significantly. Below is a figure of a built-in note in PassXYZ. The title “How to use PassXYZ” is a brief explanation of the usage of PassXYZ. As we can see, it is very similar to a document edited using MS Word or HTML. With Markdown support, the editing is done in the editing mode and the view of document is in the reading mode. This is the difference comparing to plain text, as in the plain text, there is no difference between editing and reading. In the below figure, there is a Pen icon on the top right of the screen. By clicking it, the note will be switched to its editing mode.

markdown02

Embedded HTML inside Markdown

From the above example, we can see that there is no learning curve to use Markdown for most of the users. With Markdown support, we can create a document on mobile device with similar result of MS Word or HTML. If you have experiences in writing blog or creating your own website, you may have learnt or known HTML. Usually, Markdown allows mixing together with HTML language to present content. With embedded HTML, you can get Secure Notes to do more things comparing to the pure Markdown documents. The following example explains more. A typical Sample Entry that you can find once you install KeePass on Windows is recreated as shown in the below figure.

markdown03

As you can see, we used an HTML table to recreate a KeePass sample entry. Inside the table, we can use a password control to present the password field in KeePass. We can click the small checkbox next to the password field to show or hide the password. With embedded HTML, we can recreate almost all different entries supported by either KeePass or PassXYZ. The expense is that you have to know HTML, and the editing effort is much more than that of the normal entry. This is just a simple example to show the power of the mixed usage of HTML and Markdown. You can explore more on your own with this function in PassXYZ.

In this article, we have introduced what Markdown is and how Markdown helps us in the Secure Notes of PassXYZ. For the professional editing software, such as MS Word and lightweight notes in mobile devices, they have their own advantages or limitations. It will be difficult to use MS Word without a PC and a mouse. However, there is not any difficulty to use the Secure Notes of PassXYZ in mobile devices. In the Secure Notes, you can add simple Markdown markups to enjoy a similar effect just as you add a “:)” to show a smiley face when you send a message.

We hope that PassXYZ users can use Markdown to create their own personalized secure notes without any difficulties after reading this article.


If you are interested in the personal information management, please add PassXYZ Wechat public account by searching the keyword PassXYZ or link it using Wechat name passxyz_kpclib. The source code of KPCLib can be found at GitHub at https://github.com/passxyz/KPCLib.

You can also find more information about PassXYZ on its website and install it from Google Play, Apple Store and Microsoft Store.