After knowing the image upload method, the following is a detailed description of how to configure the Amazon S3 image upload service. After configuration, you can easily upload images in Markdown documents to Amazon S3.

First, go to "Settings - Publishing" and add the Amazon S3 image upload service. At this time, the information filling interface shown in the figure below will be displayed. The figure below is the filling interface of the Mac version of MWeb, and the iPad/iPhone platform is the same.

The following will explain each item in detail.

Name: You can fill in the name you want, as long as it can identify this image upload service.

AWS Region: and Bucket Name:, you will know it after creating the bucket. Among them, you can click the "Choose Region..." button to choose the AWS region, or fill it in directly. As shown in the figure below, my AWS region is: ap-southeast-2, and the bucket name is: mwebapp.
Please note that bucket name with . is not supported, for example, bucket name like s3.sample.com are not supported. For details, please check S3 Bucket naming rules documention.

Access Key: and Secret Access Key: For these two, you need to create users and assign permissions in Identity and Access Management (IAM). This part is quite complicated. I simply created a user named mweb and granted it the AmazonS3FullAccess permission, as shown below:

After authorization, create an access key in "Security Credentials", as shown below:

In the selection of "Access key best practices & alternatives" when creating, I chose "Other", so that I can get Access Key: and Secret Access Key:, as shown below:

Domain: Amazon There is a very detailed document on how to bind a domain name to a bucket. Please refer to: Tutorial: Configuring a static website on Amazon S3. I will fill in: http://mwebapp.s3-website-ap-southeast-2.amazonaws.com.

Save Key: Please do not change unless necessary. If you want to change it, you should know what it means.

The following is a screenshot after filling in the form:

After knowing the image upload method, the following is a detailed description of how to configure the Azure Blob image upload service. After configuration, you can easily upload images in Markdown documents to Azure Blob.

First, go to "Settings - Publishing" and add the Azure Blob image upload service. At this time, the information filling interface shown in the figure below will be displayed. The figure below is the filling interface of the Mac version of MWeb, and the iPad/iPhone platform is the same.

The following will explain each item in detail.

Name: You can fill in the name you want, as long as it can identify this image upload service.

Storage account: and Storage Container:, these two can be found in the Azure management interface. If you don’t have a storage account, you can create one first. After creating a storage account, you can create a storage container in the storage account. Azure Blob has a quick way to configure the files in the Blob as a static website. After creating a storage account, enter the storage account, select "Data management - Static website", and click the "Enabled" button. Azure will automatically generate a storage container named $web in this storage account and provide a temporary domain name https://mwebbob.z7.web.core.windows.net/, as shown below:

Access key: It is bound to the storage account. After entering the storage account, select "Security + network - Access keys" to find the access key, as shown below:

Domain: If a domain name is bound to this storage bucket, please fill in your own domain name. If not, you can use the temporary domain name of the static website mentioned above. Here is: https://mwebbob.z7.web.core.windows.net/.

Save Key: Please do not change unless necessary. If you want to change it, you should know what it means.

The following is a screenshot after filling in the form:

After knowing the image upload method, the following is a detailed description of how to configure the Cloudflare R2 image upload service. After configuration, you can easily upload images in Markdown documents to Cloudflare R2.

First, go to "Settings - Publishing" and add the Cloudflare R2 image upload service. At this time, the information filling interface shown in the figure below will be displayed. The figure below is the filling interface of the Mac version of MWeb, and the iPad/iPhone platform is the same.

The following will explain each entry item in detail.

Name: You can fill in the name you want, as long as it can identify this image upload service.

Account ID: and Bucket Name: can be found in the Cloudflare R2 management interface. If you don't have a bucket, you can create one, as shown below:

Access Key: and Secret Access Key: need to be generated by clicking "Manage R2 API Tokens" in the above picture (just below the Account ID). The following picture is an example of creating these two keys:

After clicking the "Create API Token" button, you will get Access Key: and Secret Access Key:, as shown below. Please fill them in respectively.

Domain: If you have a domain name bound to this bucket, please fill in your own domain name. If not, Cloudflare R2 also provides a temporary domain name in "R2 - Bucket - Settings - R2.dev Subdomain", as shown below. Mine is: https://pub-e7575c891a134e899fd1c81d49f23497.r2.dev

Save Key: If not necessary, please do not change it. If you want to change it, you should know what it means.

The following is a screenshot after filling in the form:

MWeb 4 Library Mode iCloud synchronization question.

What is the difference between MWeb 3's iCloud synchronization and MWeb 4's?

The synchronization of MWeb 3 is to save the folder of the Library in iCloud Drive, and the system will synchronize the files. The synchronization of MWeb 4 uses a technology called CloudKit for synchronization, which is controlled by MWeb and is no longer stored in iCloud Drive. If you want to use MWeb 4's iCloud synchronization, you need to click the "Store in iCloud" button in the settings.

How ​​to synchronize the Library of MWeb 3 to iCloud?

If it is the macOS version of MWeb, please confirm whether it is stored in the folder of iCloud Drive or related cloud drive. If it is, you need to ensure that the folder the Library is completely synchronized to the local.
Then, in the Preferences - Library, click the Store in iCloud button, and then in the pop-up prompt whether to merge the Library, choose Merge.
This prompt will only be displayed once. If it is too late to choose before, you can switch back to the local document library first, then exit MWeb, and run it on the command line:

defaults write com.coderforart.MWeb3 ckIsChooseMergeLocalToCloudKit -boolean false

Then start MWeb and re-select Store in iCloud, and it will prompt again whether to merge.

If it is the iOS version of MWeb, because the original iOS version of the document library is read-only, you need to use the macOS version of MWeb first, and synchronize the document library to iCloud according to the above method. Then set the document library to store in iCloud on the iOS version.

Can I manually git back up the Library?

Yes, in MWeb 4, Apple’s CloudKit technology is used for synchronization, which will completely synchronize all documents to a private folder in the local MWeb, the location is: ~/Library/Containers/com.coderforart .MWeb3/Data/Library/Application Support/MWebLibrary.
If you want to back up or git backup, you only need to back up this location regularly.

The structure of the document library in this location is the same as the local one. If you don’t want to use iCloud for synchronization, you can copy this folder to other places, then switch back to the local folder storage in MWeb, and then select the folder to copy to. That's it.

What should I do if the desired document version is overwritten during iCloud synchronization?

In the macOS version of MWeb, you can use the menu: File - Revert to... - Browse all versions. For the iOS version, please tap "..." button and choose "Document History...". It is recommended to avoid editing the same document on multiple devices when using it. If you want to edit, please make sure that the document is up to date.
Because the synchronization process is stateless, for example, the current device’s network is not good, network transmission errors, CloudKit errors, etc., will cause the latest version of the current device’s document to be unable to be synchronized to CloudKit in time. At this time, if another device uploads it The new version of the document, and then the current device becomes normal, it will receive an update push from another device, and then the document of the current device will be updated.

MWeb 3.x How to upgrade to MWeb 4.x?

Note: Users of MWeb 3.x can upgrade to MWeb 4.x for free. The upgrade method is: download MWeb 4.x, there will be an "License Upgrade" button in the pop-up interface of the software, click this button You can redeem the 3.x activation code for the 4.x activation code.

Mac App Store users: Please update directly from the Mac App Store.

Tip: MWeb 2.x upgrade to 4.x requires a new payment. If you want to download version 3.x, please click here to download MWeb 3.x. If you want to download the 2.x version, please go to the bottom of the Download MWeb page to download.

After upgrading from MWeb 3, how to find the original preview style? Does MWeb 4 still support custom preview styles?

The original custom style CSS file of MWeb 3 is still in its original place, at the location of ~/Library/Containers/com.coderforart.MWeb3/Data/Documents/themes/PreviewCSS. Then MWeb 4 also supports custom preview styles. The way is to click the Custom Theme button in Preferences - General, choose to add a theme according to the current template, in the window that comes out, uncheck Automatically generate Preview CSS by the Editor Theme., and then paste the content of the CSS file into it.

The custom preview style feature of the iOS version is not available in the current version, but it will be added soon. The original custom CSS file of the iOS version is still kept in your phone. In the next version, you can click "Export MWeb 3 custom preview" at the bottom of the settings page to export your custom CSS style file .

Can't activate after purchasing or redeeming the MWeb 4 activation code?

You can check whether the domain name paddle.com is blocked. Currently, MWeb 4 uses this related service.

Markdown syntax changes

Currently MWeb 4 uses CommonMark standard and GitHub Flavored Markdown (GFM) grammar. For detailed grammar, please refer to:

CommonMark: https://commonmark.org/help/
GitHub Flavored Markdown (GFM): https://guides.github.com/features/mastering-markdown/

There will be some slight changes in the parsing of the grammar. For example, ##If there is no space, it will not be parsed as a title. In addition, the old version of syntax highlighting ==highlighting== is no longer supported. If you really want to use it, you can only use HTML, such as <mark>highlight</mark>.

Changes in image upload service

The method of inserting a local picture and then uploading remains the same. The function of automatically uploading when inserting has changed, and it has been changed to a separate picture upload window. Use the menu: View - Images Upload Window to open this window. The following figure is the change from MWeb 3 to MWeb 4. The left is the MWeb 3 method, and the right is the MWeb 4 method:

other questions?

If you have any questions, please send to coderforart+233@gmail.com this email, I will usually reply you within 1 to 3 working days, thank you very much!

MWeb for iOS IAP only $4.99！You can buy in MWeb for iOS setting page.

MWeb for macOS recent update

Version 3.2.1

• Add: Publishing Services add Pandoc & Run Scripts.
• Add: Publishing to Yuque https://www.yuque.com/ .
• Add: "Upload Local Images to.." - "Copy HTML with Style".
• Add: Preview mode add CMD + F for find.
• Add: External mode add clear unreferenced images (Right click folder - Clear Unreferenced Images...).
• Upload to qiniu support custom path, you can use: {year} {mon} {day} {random} {filename} {.suffix}.
• External mode search: 1. more faster full text search. 2. add a search button to left-bottom. 3. add menu: right click folder - search this folder. 4. shortcut CMD + O change to search current document's folder.
• When importing into the Library, if you choose a folder, the documents in the folder and the attachments related to the document will be imported together (previously only related images will be imported)
• Mermaid library update to version 8.0.0.
• Fix some export to epub bug.
• Other bug fixes and stability improvements.

Version 3.2.2

• Fix External mode Epub export bug.
• Publish to yuque now can custom yuque url.

version 3.2.3

• Image Upload Services support Tencent COS.
• Publish to Yuque.com now can upload images to Yuque (please re-add the Yuque publishing services).

MWeb for iOS recent update

Version 3.0.0

• New Interface.
• Quick Note.
• Add Url Schemes 1. New Library Document: mwebapp://?p=newlibdoc 2. Quick Note: mwebapp://?p=quicknote .
• Full Text Search.
• Bug fixes and stability improvements.

More info: https://www.mweb.im/mweb-ios-3.0-release.html

Version 3.0.3:

• New: Now you can add the Working Copy or Files app's folder to MWeb. You can add in "Cloud Documents - New Folder (the toolbar in bottom ) - Add Third Party Folder".
• New: Publishing Services add publish to sspai Matrix.
• New: Export to add "Share the Document" that you can share by AirDrop.
• New: Tap sync to Dropbox button will show the sync detail.
• Dropbox sync now will sync the small size file after the big size file.
• Preview now can show MWeb for macOS graphics define like mermaid, viz, echarts, plantuml, sequence and flow chart.
• Export to HTML now will encode local image to base64 and export it.
• Fix the sort by file name issue.
• In the Setting page, "Enable code highlight" and "Enable sequence and flow chart" are removed. These options change to alway Enable.
• Fix can't close Sidebar in iPad.
• Fix CMD + R can't switch to Preview/Editor mode.

Version 3.0.4:

• Add: Enable Autolink, Enable Code Block Line Number, Render img tag to figure.
• Fix: the Library categories sort not the same as the macOS version of MWeb.
• Fix: the order list number will auto fix when edit/delete the order list.
• Because Google close the Picasa Web API, so Google Photos image upload service are removed, please check: https://developers.google.com/picasa-web/ .
• Bug fixes and stability improvements.

Version 3.1.1:

• Add: Publishing Services add publish to yuque.com.
• Add: Images Upload Services add Tencent Cloud COS.
• Improvement: upload to qiniu support custom path, you can use: {year} {mon} {day} {random} {filename} {.suffix}.
• Improvement: now you can tap the Editor's local image for zoom and share it.
• Fix: the app crashes when rename dropbox's file.
• Fix: unable to insert gif file from Photos app.
• Other bug fixes and stability improvements.

Version 3.1.2

• Publish to Yuque.com now can upload images to yuque (please re-add the Yuque publishing services).

As shown below, this is a new interface, you can see that there is almost no major change. The biggest change is that the document navigation becomes the sidebar, and the editor becomes always displayed, that is, when switching the document to be opened, the original opened document will not be closed.

Open Markdown or text document in the Files app

This update optimizes this use. In the toolbar at the bottom of the sidebar, the last two buttons are resident. The last one is to close the sidebar button. The other one is the open the Markdown or Text document in the Files app. Thanks to the new mechanism of iOS 11 and above, the client of the cloud drive such as Dropbox, Google Drive, and One Drive are installed, the relevant cloud drive document can be accessed in the Files app. This is very convenient, so that MWeb can access the files of other cloud drive through the Files app without synchronizing functions.
Since iOS does not currently have access to a folder in the file application, the Markdown document in the MWeb Open Files app does not currently support inserting images into the document. If you need to insert a picture, you can configure the Images Upload Services in MWeb, so that after inserting the picture, MWeb will automatically upload to the Images Upload Services. Also, in the Files app, you can also choose to open Markdown and text documents using MWeb.

Quick Note

Quick Note provide a concept: whenever you need to take notes, just click on the Quick Note button to start recording right away, regardless of file name, location, how to sort it, and so on. Just write down to complete the task, as for finishing or what, it is the next thing, do not have to consider, reduce the burden, just to write down.

The Quick Note provides three entries, as shown in the following for two entries, and one way is to use URL Scheme:mwebapp://?p=quicknote . After clicking, MWeb will automatically open the document of the quick note and pop up the keyboard according to the rules of the settings of the picture on the far right of the picture below. The focus of quick note is to remember, just write down, MWeb will automatically organize the documents into days. When you click on a quick note, if the quick note is not open, it will automatically add date and time as the title.

If you save the quick note settings in the MWeb for Mac document library, there is currently no support for categorization into a category, and the iOS version of the document library synchronization and full functionality will be improved in several versions.

The following picture shows the situation of the Quick Note Editor and the folder for viewing the quick note of the previous date (I saved it in the demo folder folder in this machine).

Improvements of the Markdown keyboard

As shown above, the Markdown syntax input keyboard has changed the style, insert image from Files app button and preview button have been added. In addition, in the Settings - Customize Keyboard Toolbar Buttons, you can also adjust the order and settings in the top toolbar, as shown in the image on the right side of the figure above.
On the left side of the image above, the top toolbar can be swiped to the left to see other hidden buttons. In addition, MWeb also provides a button to switch all Markdown syntax input keyboards, so if you don't like to use the slide mode, you can click this button to insert Markdown syntax.

Full Text Search

At present, this version finally supports full-text search. If the current search is separated by spaces, for example, by filling in the "want to", the search document will found both "want" and "to" documents.

Document Library Improvements

As shown in the figure below, the document library home page has been added to display the newly added documents. This function should be convenient before all the functions of the document library are perfected. In addition, directly clicking on the classification will enter the effect of the right image as shown below. The sub-categories of this category will be displayed first, and then the documents under this category will be displayed. Then there is a URL Scheme:mwebapp://?p=newlibdoc with a new document library document added.
It should be noted that the current document library still does not support deletion, management classification and document categorization functions. These feature will be update in this year.

Cloud Documents

The device's documents now move to the Cloud Documents page. In addition, tap the (i) button can set the folder options, as shown in the following figure.

That's all, thanks.

The Quick Note provides three entries, as shown in the following for two entries, and one way is to use URL Scheme:mwebapp://?p=quicknote . After clicking, MWeb will automatically open the document of the quick note and pop up the keyboard according to the rules of the settings of the picture on the far right of the picture below. The focus of quick note is to remember, just write down, MWeb will automatically organize the documents into days. When you click on a quick note, if the quick note is not open, it will automatically add date and time as the title.

If you save the quick note settings in the MWeb for Mac document library, there is currently no support for categorization into a category, and the iOS version of the document library synchronization and full functionality will be improved in several versions.

The following picture shows the situation of the Quick Note Editor and the folder for viewing the quick note of the previous date (I saved it in the demo folder folder in this machine).

1. MWeb 2.x users also need to re-purchase, this is because the Mac App Store is not friendly for old users upgrade.
   For out of Mac App Store users, if purchased from May 1, 2018 to July 3, 2018, you can contact me to change to 3.x version, notice that is Change, you 2.x will disable.
2. MWeb updates can't be avoided. It's free to upgrade MWeb from 1.x to 2.x. For MWeb development, 3.x will have to re-charge. The subscription method is indeed more appropriate, but MWeb will be converted to a subscription of at least $1.99 monthly, so the new version is actually more favorable. I think that even if the prices of the two versions add up, it is still very cheap compared to some of the products. The advantage of the buyout system is that you don't have to worry about renewal after you buy it, and you will have the feeling that you already have. I think this experience is very good.
3. Regarding MWeb 2.x, maintenance is generally compatible with new systems. The plan is to do simple maintenance, but if it is too difficult to compatible the new system one day, it will be removed from sale. But for the current macOS system status (macOS Mojave), I think you can continue to use MWeb 2.x two or there years.

2.x User Data Migration

Document Library migration:

3.x will prompt you to import the old document library when you start. If you don't do this at first, or for any other reason, the solution is very simple. Copy the old document library to the location you want, and then use 3.x. Version of the Preferences - Library & Backup - Change the Library Location-Choose a Exist Library and then select that location:

If there are any problems, it is recommended to check this post: MWeb Document Library Details.

Other data migration:

1. Publish service migration: update 2.x version to 2.3.0 and export the publishing service, and then import with 3.x. It should be noted that the Evernote Publishing Service cannot be imported and needs to be re-added.
2. External Mode migration: need to re-add the external folder in 3.x.

Difference between 3.x and 2.x.

1. 2.x version under High Sierra may have bugs that I can't reproduce. The classic problem is that the CPU is 100%. This 3.x is not there, because 3.x is rewritten. If you are using version 2.x and can reproduce this bug stably, please contact me.
2. The 3.x version of the interface is based on EL Capitan, so it will be more modern and more reasonable, and the performance will be much better than the 2.x version. The interface is also completely redesigned by the designer [@Funpee] (https://armgod.com/).
3. 3.x's Markdown parser is @randomatom to help with a lot of bug fixes and detail adjustments. For example, lists and code blocks don't force blank lines, which makes it more reasonable.
4. 3.x added support mermaid, viz, echarts, plantuml These graph libraries.
5. 3.x Custom Preview Styles no longer support the entire folder customization as in 2.x, only a single CSS file.
6. The 3.x version replaced the code highlighting library when previewing and supported the line number. The difference with 2.x is that 2.x will try to highlight if the code language is not defined, and 3.x will not.
7. 3.x The style of posting to Evernote no longer supports matching with various preview styles, the style cannot be changed, only the same as the mweb-default style.
8. 3.x's full-text search has been optimized, it should be faster, and optimization will continue.
9. 3.x Export images and PDFs Add a preview step.
10. 3.x Added export to Epub, support for single document, select multiple documents and export the category to Epub. The exported Epub also supports LaTeX math formulas.
11. Version 3.x Export HTML becomes a single file, the image is embedded in the HTML, and there is no longer the ability to export the entire category to HTML.
12. 3.x version optimizes the custom drag sorting feature in the document library, not as confusing as 2.x.
13. 3.x version When importing Markdown into the document library, if the entire folder is selected and the Markdown document has a local image, the image will also be imported, and the 2.x version will not import the image. When exporting to Markdown, version 3.x will generate a folder structure for the categories structure, and version 2.x will not.
14. 3.x version of the new Quick Note feature, please check: Quick Note.
15. The 3.x version has a new Quick Search feature. For details, please check: Quick Search.
16. 3.x Mac App Store (MAS) version has iCloud support built in. The non-MAS version is the same as 2.x and is not processed. The difference between the 3.x MAS version and the non-MAS version is explained below.
17. The 3.x version of the outline view is changed to pop-up. If it is to be fixed, it is required to be dragged and fixed, unlike the 2.x version of the sidebar.
18. The 3.x version of the External Mode becomes a two-column mode, while 2.x is a three-column mode. More info: MWeb External Mode Details.
19. Finally, the release of version 3.x is only the beginning, and will continue to be optimized in the future, while 2.x enters maintenance mode.

For more information on the 3.x version, check out [Help Documentation] (help.html).

Difference between MWeb 3 Mac App Store (MAS) version and non-MAS version

1. If you need to sync data with iCloud and also use iOS version of MWeb, we suggestion that buy the MAS version.
2. When the MAS version is first launch, it will automatically set the document library store to iCloud Drive. If it is store in iCloud Drive, it will automatically detect the document library in iCloud Drive. Non-MAS versions are manually selected.
3. The MAS version moves the document library to iCloud Drive no need to manually choose the iCloud Drive MWeb library location.
4. The non-MAS sync document library to iOS version is the same as the 2.x version, which is also to manually save the document library to iCloud Dirve/MWeb/mweb_documents_library. For details, please check: How to use MWeb for Mac Library in iOS
5. The non-MAS version is currently not Sandbox app. The difference is:
   1. The non-MAS version can preview external markdown document that contain local image no need to add the folder to External Mode.
   2. Non-MAS version exporting PDF under Sierra also supports TOC, which are not supported by MAS version. Notice that both versions of EL Capitan and High Sierra support PDF TOC.

In MWeb's document library, there are two categories, one is the general category, and the other is the static website category. You can add a static website category directly, or right click in the category of the top level of the general category, select Edit, and then click the Set to Site button in the interface that comes out.

Website category can set some things related to the website. The setting interface is as follows:

The settings in the above picture should not be difficult to understand. If you want to generate a static website, after setting it, click the Build Site button. Before generating, please make sure that there is at least one article in your category. You can also right click to select the relevant menu item to generate the website. If you have modified the site template, use the Clear and Rebuild Site button. Of course, you can use this button to clean up and regenerate your website at any time.

It can be seen that generating a static website in MWeb is very simple. Write a good article, then classify it into a static website category, then right-click on the static website category and select Generate Website. Of course, you can preview it first.

Two article type in MWeb

MWeb and Wordpress and other blogs have the same structure, divided into two articles type: general article and Page. Page is used to do pages like about page, contact page, etc.

As shown in the figure below, it is very simple to set the document in the MWeb document library to page. Click top of the information bar and check Is Page. The HTML file name is used to set the name of the generated HTML file. For example, the article in the above image will generate mweb-static-blog.html. general article The generated HTML file name is also set here.

Setting the main menu of the website

You can click the Advanced Settings button in the website settings interface to open the website extension to set the main menu of the website. You can also open it from Preferences - Extension, then select the website category to be set and select the Site Menu. This tab, as shown below:

You can add, edit, and delete menus, or drag and drop to adjust the order. Notice: the MWeb-Foundation-Book template does not support the website menu.

Reference between documents

It is very simple to reference other documents in MWeb. In the document list, right-click the document you want to reference and select Copy as shown below.

Then paste the location of the document to be referenced CMD + V, and MWeb will generate [How to use Publish Script to Publish website.](how_to_use_shell_script.html). If you hold down the CMD key and click, the referenced document will be opened.

The Generate Static Website feature handles this reference very well and generates related web links.

Add the Read More Comment

For Read More Comment, please see the image below. You can use the menu: Actions - Insert Read More Comment to insert more readings, and then note that this comment must add a empty line in top and bottom, as follows Figure.

Configuring website publishing scripts

This feature, MWeb for Mac 2.2.3, is designed to make the static website experience in MWeb reach the "new document and edit" - "right click and choose to execute the release script" as a simple process. Avoid the same as before, after you generate the website, you need to click the command to publish.
For detailed instructions, please refer to this article directly: How to use Publish Script to Publish website.

Mac App Store Sandbox

Opening a Markdown document in a non-document library in MWeb, if there is a reference to a local image in the document, there is no way to display it and preview it in MWeb. This is because Apple's software on the Mac App Store (MAS) does not perform any operations on documents outside the software's own sandbox, and even reads it unless the user explicitly authorizes it. The way the user is authorized is to use the Open, Save dialog. For example, if you open a Markdown document with MWeb, then MWeb can get permission to read and write this document.

If you want to use MWeb to drag and drop the function of inserting images, you need to authorize the entire folder where the document is located to MWeb. When you import the folder, MWeb will automatically get the read and write permissions of this folder.

Of course, the introduction of folders into MWeb makes it easy to open and manage Markdown documents and view the tree structure of folders without using Finder.

Add a folder to External Mode

As shown below, press CMD + E to open the external mode, then click the “+” button in the left bottom corner to select the folder to be imported.

In addition, you can also drag and drop folders directly into the folder tree list on the left to import folders.
Another way is to drag and drop the folder directly into the MWeb icon to import the folder.

Configuring imported folders

After the folder is added, there is an important setting, which is to introduce the settings of the folder, you can right-click the imported folder, and then select Edit, it will display the following interface:

One setting is the "Display Name", which is specific to the imported folder. You will not modify the name of the folder if you modify the name. There are also several important settings that are related to inserting images. The first one is "Media Folder Name:". This is followed by the "Media Save Path:" option is associated with this, and there are only two options for "Absolute" and "Relative".
For example, if the folder I imported is A, then a file is under "A/folder/file.md", if I insert a picture called "pic.jpg" in "file.md" , the result of the different options is:

1. Relative: The picture will be saved in “A/folder/media/pic.jpg”, and the generated Markdown will be: ![](media/pic.jpg).
2. Absolute: The picture will be saved in “A/media/pic.jpg”, and the generated Markdwon is: ![](/media/pic.jpg.

Another setting: "Automatically upload the inserted image to...". If this option is checked, the above settings will not work because the image you inserted will be automatically uploaded to the selected image upload service and then returned to the Markdown syntax.

Based on this feature, MWeb can support image insertion, preview and management of static website generation tools such as Octpress, Jekyll, hexo, gitbook, VuePress and so on.

Manage imported folders

After the folder is imported, you can use the right button to perform some common operations on the imported folders and files, as shown in the following figure.

Quick search of the Library

The following image is a quick search of the document library. If the search keyword is not filled in, the currently open document and the most recently used document will be displayed.

Press the Down key to select the document and press Enter to open the selected document.

In addition, the document library search can also set a global search shortcut. Press this shortcut to search the document library at any time. This shortcut can be set in Preferences - General, as shown below:

The following image shows the results of opening a quick search and searching from the desktop after setting a shortcut.

Quick search for external mode

As shown in the figure below, the currently open document and the most recently used document are displayed without filling in the search keyword.

As shown in the following figure, press Down key to select the document, press Enter to open the selected document.

Search syntax

MWeb 3.1.8 and above support search syntax like below:

[keyword1] [keyword2]... [-c category1,category2...] [-t tag1,tag2...] [-h keyword1,keyword2,...]

For Example:

1. If you fill: "MWeb Blog", it will search the document content that contains "MWeb" and "Blog" keywords.
2. If you fill: "MWeb Blog -c cat1,cat2", it will search the document's categories contains "cat1" and "cat2" and the content contains "MWeb" and "Blog" keywords.
3. If you fill: "MWeb Blog -h key1,key2", it will search the document's title contains "key1" and "key2" and the content contains "MWeb" and "Blog" keywords.
4. In External Mode, If you fill: "MWeb Blog -h key1,key2", it will search the document's file name contains "key1" and "key2" and the content contains "MWeb" and "Blog" keywords.

The quick note feature is essentially to add documents according to a certain period of time (days) and save them to the set category of the Library or folder (only supported by iPadOS/iOS). Mainly to achieve, when you want to record text or images, you only need to click a button to start immediately.

Enable quick note feature

This feature is disabled by default. If you want to enable it, in MWeb for macOS, please enable it in Preferences - General; in MWeb for iPadOS/iOS, please enable it in Settings Page - Quick Note. The following figure shows the settings interface in macOS and iOS respectively.

You can set the time when quick notes are saved in that category and generate a new document. If you use it frequently, you can only write one a day. Otherwise, you can choose 3, 5, 7 days, etc. Among them, there is a check box of Automatically insert time. If it is checked, it will automatically add a line of current time as the title when recording a quick note.

Use quick note feature

In the macOS version of MWeb, if Quick Notes is enabled, a button with an "M" icon will be displayed in the status bar. After clicking, Quick Notes can be used, as shown on the left side of the following figure; in the iPadOS/iOS version of MWeb , if MWeb is not open, you can press and hold the MWeb icon and select "Quick Note" to use Quick Notes. If MWeb is open, you can directly press the button in the middle of the bottom of the navigation page to use Quick Notes, as shown in the red box on the right side of the figure below.

The Library storage location

MWeb's Library can be stored in a folder, or in iCloud (synchronized using CloudKit technology). In MWeb for macOS, you can view the location where the Library is stored in Preferences - Library & Backup; in MWeb for iPadOS/iOS, you can view the location of the Library in Settings Page - Library. It should be noted that under iPadOS/iOS, if your Library is not stored in iCloud, when you delete the MWeb app, the Library will also be deleted! Therefore, it is recommended that set the Library stored in iCloud on iPadOS/iOS. If you want to sync across multiple devices, please also store your Library in iCloud.

The Library structure, backup and restore from backup

In general, it is not necessary to understand the structure of the Library. If you are using MWeb under macOS and want to backup or restore the Library, then it is necessary to understand the structure of the Library. Under macOS, when the Library is stored in a folder, you can directly view the folder where the Library is located to understand the structure of the Library. When the Library is stored in iCloud, MWeb will use CloudKit technology to completely synchronize the entire Library to a private folder of the MWeb. the located at: ~/Library/Containers/com.coderforart.MWeb3/ Data/Library/Application Support/MWebLibrary. If you are using MWeb Standard version, please replace com.coderforart.MWeb3 with com.coderforart.iOS.MWeb.

The folder structure of the Library is composed of the docs folder, the mainlib.db file and the metadata folder. Among them, the docs folder contains the related materials of each note . The mainlib.db file saves the category and tag information and the category information to which the note belongs. The metadata folder only exists when the publishing service is used, and saves the information related to the publishing service. The figure below is a typical Library structure.

This structure works well for backups and for git backups, and you may have noticed that even if you choose to store your Library in iCloud, you can also back up your Library. Because MWeb will sync all data to a private folder, you only need to backup that folder.

Under macOS, if you want to restore a Library from a backup, there are two cases:

1. When the Library is stored in a folder: first copy the folder of the backup Library to the location you want, then in Preferences - Library & Backup, click the "Choose an Existing Library..." button and select that location.
2. When the Library is stored in iCloud: First, replace the files in the private folder (mentioned above) of the Library synchronization with all the files in the folder of the backed up Library. Then, restart MWeb and check if there is any problem with the data. If there is no problem, click the "Sync" button, in the menu that appears, select "problem with synchronization?", and in the interface that appears, click "Re-upload the current Library to iCloud". After the upload is complete, go to this interface and click "Re-download all content on iCloud".

How to use the categories tree

There are two types of MWeb categories, one is the common categories, as shown below:

One is static website categories, this categories can generate static websites, as shown below:

MWeb provides a very simple way to generate a static website from the classified documents. For example, MWeb Chinese official website is generated by MWeb's static website function.

The categories tree on the left side of the interface can be associated with the right-click and drag-and-drop to complete related management operations. The middle document list bar can drag and drop documents to the left category for document categories management. There are three cases of this drag and drop, and the following assumes that the drag is Category A:

1. Drag the current document directly to Category A. In this case, if the document in the list belongs to the currently selected category, it will move to the Class A, otherwise it will be added to the Category A for the dragged document.
2. Hold down the CMD key to drag the current document to the Category A. In this case, the added value of the dragged document is increased to Class A.
3. Hold down the Option button and drag the current document to the Category A. In this case, if the dragged document belongs to the Category A, the canceled document belongs to the Class A, If it does not belong to the Class A, no action is taken.

This method of operation is more than one choice, that is, it can be managed in batches. If it is a single document, there is a better way to click on the top information bar of the editor and then check it, as shown below:

This place is also the only place where you can set the document tag. You can also use the shortcut CMD + 8 to open this interface.

Reference between documents

It is very simple to reference other documents in MWeb. In the document list, right-click the document you want to reference and select ``.

Then paste the location of the document to be referenced CMD + V, and MWeb will generate [How to use Publish Script to Publish website.](how_to_use_shell_script.html). If you hold down the CMD key and click, the referenced document will be opened.

Document Sorting

The document library supports multiple sorting methods, and each top-level category can also set its own sorting method. There are two ways to modify the sorting method, one is as shown below:

The other is to select the top-level category to be modified or a sub-category under the top-level category, and then right-click in the document list, as shown below:

In various sorts, custom drag sorting is special and requires special instructions. Before I explain, let me explain a global option: Group By Categories Right-click in the document list to see the menu for this function. If it is enabled, it means that the documents in the list are in the state of grouping by category, no matter what sorting settings.
This use is actually to find and organize documents. However, if this global option is not enabled, then if the sort is set to a custom drag sort, the top level will also be grouped by category. In other words, as long as it is a custom drag sort, the document list bar must be displayed in groups.
This is due to the fact that a document can belong to multiple categories and the rules are set, otherwise it will be messy.
If you try to drag and drop in a category that is not a custom sort, MWeb will prompt you to set it to a custom drag sort before you can drag and drop. Customize the documents under the drag sort category, it is recommended to ensure that only one category is classified, so drag and drop sorting will not be messy.

How to use tags

The function of the tag in MWeb is very simple. The method of setting the tag is as mentioned above. In addition, the document is viewed by Tag, as shown below:

It can be seen that MWeb will list the tags of the entire document library and the tags under the currently selected category. After selecting, you can view the documents by tag.

Document Outline View

As shown in the following figure, the document outline view will list the title and inserted images and attachments of the current document, and of course the extension items that can be used for static websites (if the current document belongs to a static website category). The figure below shows the effect of fixing the outline view.

Import and export of document libraries

As shown in the following figure, the document library supports importing Markdown documents into the document library. If you select a folder when importing, MWeb will import all the Markdown documents in the folder into the currently selected category. If there is a local image in the Markdown document of the folder, it will also be imported and modified to the image address in the document library format. This is only available in version 3.x. Version 2.x will only import Markdown text and will not import images. It should be noted that to import images, be sure to select the entire folder.

In addition, you can export the entire categories to Markdown, and the exported Markdown document will create a folder according to the structure of the categories. Creating folders by category structure is also a feature that is only available in 3.x.

The remaining two are exported to Epub and PDF. Yes, you can export the entire category to Epub or PDF!

Some question with MWeb 4 iCloud sync Library

What's the difference between MWeb 3's iCloud sync and MWeb 4's?

The synchronization of MWeb 3 is to save the folder of the Library in iCloud Drive, and the system will synchronize the files. The synchronization of MWeb 4 is performed using a technology called CloudKit, which is controlled by MWeb and is no longer stored in iCloud Drive. If you want to use MWeb 4's iCloud sync, you need to manually click the "Store to iCloud" button in the Preferences - Library & Backup.

How ​​does MWeb 3's Library sync to iCloud?

If it is the macOS version of MWeb, please first confirm whether it is saved to the folder of iCloud Drive or a related cloud drive. If so, you need to ensure that the folder where the Library is located is completely synchronized to the local. In short, we must first ensure that the current Library is complete sync.

Then, in Preferences - Library & Backup, click the Store in iCloud button, and then select Merge in the pop-up prompt to choose whether to merge Library.
This prompt is only displayed once. If it is too late to choose, you can refer to the method of restoring from backup in "The Library structure, backup and restore from backup" at the top of this article.

If it is the iOS version of MWeb, because the original iOS version of the Library is read-only, you need to use the macOS version of MWeb first, and synchronize the Library to iCloud according to the above method. Then in the iOS version, you can also set the Library to Store in iCloud.

Can I manually git backup my Library when choose stored to iCloud?

Yes, in MWeb 4, Apple's CloudKit technology is used for synchronization, which will completely synchronize all documents to a private folder of the local MWeb, located at: ~/Library/Containers/com.coderforart .MWeb3/Data/Library/Application Support/MWebLibrary. If you are using MWeb Standard version, please replace com.coderforart.MWeb3 with com.coderforart.iOS.MWeb.
If you want backups or git backups, just back up this location regularly. This location can only be backed up, please do not change it.

The structure of the Library in this location is the same as the local one. If you do not want to use iCloud synchronization, you can copy this folder to other places, then switch back to the local folder storage in MWeb, and then select the copied folder That's it.

What if the desired version of the document is overwritten when syncing with iCloud?

In the macOS version of MWeb, you can use the menu: File - Revert to - Browse All Versions, for the iOS version, you can click the "..." button and select "Document History..." to restore. It should be noted that the document version for iOS is only for iCloud-synced documents in the Library. It is recommended to avoid editing the same document on multiple devices. If you want to edit it, please confirm that the document is in the latest state.
Because the synchronization process is stateless, for example, the current device network is not good, network transmission errors, CloudKit errors, etc. will cause the latest version of the current device's document to be unable to be synchronized to CloudKit in time. At this time, if another device uploads A new version of the document, and then the current device becomes normal, will receive an update push from another device, and the current device's document will be updated.

Want to initialize the MWeb document library

If you want to initialize MWeb's document library, the methods are:

1. Download https://cdn.mwebapp.cn/MWebInitLibrary.zip and unzip it, then use Choose an Existing Library... to select the location after unzipping.
2. Run the command on the command line: defaults delete com.coderforart.MWeb3 (or defaults delete com.coderforart.iOS.MWeb if MWeb Standard version), this operation will delete all MWeb preferences, Start all over again.

1. Upload to the image upload service first, then copy the Markdown syntax to the editor

After adding the image upload service, please open the image upload window. In MWeb for macOS, please use the menu: View - Image Upload Window to open; in MWeb for iPadOS/iOS, please click the "..." button at the bottom of the editor, in the , select Images Upload..., or click the relevant button in the toolbar to open it. The interface of the Image Upload Window is shown in the figure below. The usage method is very simple.

2. Automatically copy to the relative position of the document when inserting a image

This is the method recommended by MWeb. In this way, you only need to complete the writing of the document. When you need to upload the images in the document to the image upload service and publish them, in MWeb for macOS, please use the menu: Publish - Upload Local Image to...; in MWeb for iPadOS/iOS, please click the Share button at the bottom of the editor and select the image upload service that you want to upload to. After the operation is performed, the image upload interface as shown below will be displayed:

In this interface, the list in the middle will list all the local images in the document. First, please select the image upload service, and then click the "Upload Image" button. When the image is uploaded, you can choose to use the "Copy Markdown" button or the "Copy HTML" button, depending on what format you want. What is copied in is the content after the local image address has been replaced with the remote address of the image upload service.

Adding and using publishing services

To use publishing service, please add the publishing service first. For macOS version of MWeb, please add related publishing services in Preferences - Publishing; for iPadOS/iOS version, please add related publishing services in Settings Page - Publishing, as shown below:

After publishing services are added, you can also use drag and drop to change the order of publishing services. In MWeb for macOS, all added publishing services will be displayed in the Publish menu and also in the menu popped up by the Share button on the toolbar; in iPadOS/iOS, the publishing services will be displayed in the editor The Share button at the bottom pops up the menu, as shown below:

In the current document, select the publishing service to be published to, and then the relevant interface can be called for publishing.

Almost all publishing services support publishing local images. Except for Medium, almost all publishing services support updating. That is to say, for the same publishing service, after you publish it once, when you publish it again, the document will be updated. If you uncheck the update checkbox, a new article will be published, as shown below:

Metaweblog API Introduction

In the Add Publishing Service, select the Metaweblog API and the following interface will appear. In the pop-in project posted to the Metaweblog API, an item called "API Address" is added. Each website that supports the Metaweblog API provides an API address and fills in.

The Metaweblog API addresses:

• typecho blog: http://xx.com/action/xmlrpc, where xx.com is your blog URL. If typecho has not yet done url rewrite, it is http://xx.com/index.php/action/xmlrpc

Issues and solutions related to errors posted to Evernote

1. An error indicating that an HTML element is not supported is usually due to the "<" character in the document, such as <int>. The solution is to wrap it with inline code, such as: <int>, or change it to: <int>.
2. There is an error of -3000 in the prompt. To resolve this error, please delete Evernote Publishing Service, restart MWeb, and then re-add Evernote Publishing Service.

Features specific to MWeb for macOS

Copy as Rich Text feature

You can use the menu: Publish - Copy as Rich Text to use this feature. This function is mainly used to paste the current Markdown document into Mail (mail.app), Pages.app, Word.app. In the case that the Markdown document has local images, the export to docx function does not currently support images well. At this time, you can use the copy as rich text function, and then press CMD + V in the three software mentioned above to paste, so that the picture can be pasted successfully.

If you need to copy the preview style, you can try the menu: Publish - Export or Copy as Image, then select all the content in the interface, press CMD + C to copy, and then try to paste it into other editors, For example, WeChat editor.

Export to PDF or Epub

MWeb can not only export a single Markdown document as PDF or Epub, but also export multiple documents as a PDF or Epub document in the Library mode.

About export to HTML, Docx

Using MWeb to export to HTML will export a single HTML. If there is a local image, the local image will be Base64 encoded and embedded into the HTML.

In addition, exporting to Docx does not currently support local images. If the exported Docx document contains images, the current solution is to use Pandoc to export to Docx. The way to use it is to install Pandoc first, and then add the Pandoc & Run Script service in the Preferences - Publishing of MWeb. Give it a name and save it, then in the "Publish" menu, choose to run this publishing service.

In MWeb for macOS:
All supported Markdown syntaxes can be found in the "Syntax" menu or under the "Aa" button on the toolbar, and all syntaxes come with shortcuts for quick typing. Also, if you prefer to use the toolbar, you can use the menu: View - Customize Toolbar to customize the syntax input buttons on the toolbar.

In MWeb for iPadOS/iOS:
All supported Markdown syntaxes can be found in the toolbar of the virtual keyboard. In iOS, due to the small screen, you can click the "M" button on the toolbar to view all grammar buttons. If you want to customize the buttons on the toolbar, you can click the "AA" button in the upper right corner of the editor, and then click "Customize Markdown keyboard..." to customize. If you want to sea the shortcut keys, you can press and hold the "CMD" key.

Edit and preview, outline view

All platforms support edit-preview mode and outline vie. The related shortcut keys are as follows:

• Toggle edit and preview: CMD + R
• Toggle edit-preview mode: CMD + 4
• Show and hide outline view: CMD + 7

The above functions also have related buttons on the toolbar. In MWeb for macOS, you can also choose the display mode of the outline view. There are currently three types: fixed on the left side of the editor, fixed on the right side of the editor, and floating. This setting can be modified using the View menu.

Editor theme and preview style

macOS/iPadOS/iOS now have a dark theme and a light theme, so MWeb can also set the theme used when the system dark/light theme respectively. MWeb for macOS can be set in Preferences - Themes & Styles, MWeb for iOS can be set by clicking the "AA" button in the upper right corner of the edit, or in the settings page.

The preview styles of MWeb 4.x are merged with the editor styles and are collectively referred to as "themes". If you want to customize the editor style or preview style, you need to customize the theme first. In MWeb for macOS, you can click the "Custom Theme" button in Preferences - Themes & Styles; in MWeb for iPadOS/iOS, you can click the "AA" button in the upper right corner of Edit, and then click the current theme button , in the theme switching interface that appears, click the "..." button in the upper right corner to customize the theme.

If you want to customize the preview style, pay attention to the "Automatically generate preview CSS by editor" checkbox in the custom theme editing interface. If this checkbox is checked, MWeb will automatically generate the relevant CSS styles according to the color of the currently defined editor theme. If necessary, you can also fill in the redefined CSS styles in the input box below; if not checked, the related CSS styles will not be generated. In this case, you can fill in your own complete CSS styles in the input box below.

Support for insert images

Markdown is a plain text file. It does not come with any images and other attachments. Images and attachments are all referenced and stored outside the Markdown text. The main and most important feature of Markdown is "easy to read and write". In order to highlight these two advantages, I think it is necessary to be able to view the referenced images directly. Therefore, MWeb can display Markdown-referenced local and network images directly in the editor. There are four settings for this feature: show images, show thumbnails, overlay in Editor, and not show the images. If you want to modify the settings, you can set them in the Preferences in macOS/iPadOS/iOS. In macOS, you can also click the "eye" button on the toolbar to set, and in iPadOS/iOS, you can click the "AA" button in the upper right corner of the editor to set. .

macOS/iPadOS/iOS supports copying, pasting, and dragging to insert images. Of course, you can also use the Insert Image button on the toolbar to insert images.

If you're on macOS, try the following to learn more about MWeb's aspects of inserting images:

1. Press Ctrl + CMD + Shift + 4, drag and take a screenshot, in MWeb, press CMD + V to paste, and you can insert a image. If you want to insert an image in PNG format, you can use the menu: Edit - Paste as PNG.
2. In a browser (eg: Safari), find a image, then right-click the image - copy image, return to MWeb, and press CMD + V to paste to insert the image.
3. Drag and drop images directly from Finder to MWeb Editor to insert images.
4. In the Finder, find an image file, press CMD + C, return to MWeb, and press CMD + V to insert it.
5. Use the menu: Actions - Multi Images to One Image.. to experience the puzzle feature of MWeb.
6. Find an article with images and text in the website, select the images and text, press CMD + C to copy, return to MWeb, use the menu: Edit - Paste Markdown from HTML. This will automatically convert the web page to Markdown. If you want to download the network images in the webpage, you can use the menu: Edit - Remote Images Download to download the images to the local.

Set image width

The special syntax introduced by MWeb to set the image width is to add -w + image width after the image description. For example, to set the width of the above image to 140, the syntax is as follows:

![Image description-w140](https://zh.mweb.im/asset/img/set-up-git.gif)

MWeb support for inserting tables

You can press the Insert Table button on the toolbar to insert a table, or you can use the shortcut key Ctrl + Shift + T, as shown in the figure below for table insertion support on macOS, and this feature is also available on iPadOS/iOS:

For an existing table, you can move the cursor to the table syntax, and then use the Insert Table button to modify the existing table. You can insert a table first and then try to modify it.

MWeb's assistance for LaTeX, mermaid, echarts writing

In the MWeb editor, you can preview the LaTeX formula by moving the cursor to the middle of LaTeX. If you modify the formula, the preview will also be updated in real time. The following figure shows the assistance of LaTeX formulas, as well as the assistance of mermaid and echarts:

The following is a description referring to the Markdown syntax guide full version, which explains very clearly what Markdown is , what is it used for.

Markdown is intended to be as easy-to-read and easy-to-write as is feasible.
Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions.
Markdown's syntax is intended for one purpose: to be used as a format for writing for the web.

Here are two more important points:

• First of all, Markdown is plain text. It does not come with any images and other attachments. Images and attachments are all quoted and stored outside the Markdown text. Therefore, the editor of MWeb will display the text completely without any deletion. For the convenience of viewing, the editor will display the images referenced by the image syntax, but the Markdown itself is plain text without any formatting and styles.
• In addition, the goal of Markdown is to be "easy to read and write", not to look good in typesetting. It is mainly for the convenience of entering text, that is to say, in order to achieve "easy to write", it is recommended not to think too much about typesetting when writing, but only consider what grammar to use, such as headings, lists, quotes or code blocks. Markdown is not good at complex typesetting, because of complex typesetting, Markdown is recommended to write HTML directly.

Understanding these two points will help you understand the design philosophy of the software MWeb, so you can use MWeb more happily, after all, MWeb is built around Markdown. It is also helpful to understand what MWeb can and cannot do, and why there is no software A's feature or software B's way. If you have time, it is also recommended to read the article Markdown syntax guide full version.

Learn Markdown syntax

MWeb 4 uses the CommonMark standard and the syntax of GitHub Flavored Markdown (GFM). If you want to get started quickly, you only need to learn it briefly. The learning process can be divided into three steps:

1. Getting started: Currently the best place to learn is: https://commonmark.org/help/ , you can get started with 10 minutes of learning.
2. Further study: Mainly to learn the extended grammar of GFM, mainly including strikethroughs, task lists, tables and footnotes. For details, you can check the GFM grammar extensions in this article.
3. Special in MWeb: Unique in MWeb are TOC, LaTeX, drawing support (mermaid, echarts) and setting image width, which will also be explained later in this article.

The syntax of Markdown is actually very simple. Generally, you only need to understand what syntax is there, such as headings, lists, quotes, code blocks, and so on. If you don't know the details of the grammar, you can directly use the editor of MWeb to insert the relevant grammar. It can also be combined with the editor of MWeb, while learning and using, it is recommended to read the article MWeb editor introduction.

In addition, when writing Markdown documents, the blank lines is very important. Blank lines help to clearly distinguish the structure and content of the document and increase the readability of the text. In this way, when reading Markdown documents, there is no need to parse them into HTML. In general, it is recommended to leave a blank line between block elements in Markdown.

GitHub Flavored Markdown (GFM) syntax extensions

On the basis of CommonMark, Github extends some common grammars, mainly including strikethroughs, task lists, tables and footnotes. The following is a brief introduction to these grammars.

Strikethrough

Example:

 (like ~~this~~)

Result:

Any word wrapped with two tildes (like this) will appear crossed out.

Task lists

Example:

- [ ] task one not finish `- + SPACE + [ ]`
- [x] task two finished `- + SPACE + [x]`

Result:

• task one not finish - + SPACE + [ ]
• task two finished - + SPACE + [x]

Tables

Example:

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

Result:

Footnote

Example:

This is a footnote:[^sample_footnote]

Result:

This is a footnote:¹

MWeb-specific syntax

Image Width

Markdown syntax for image:

![Image description](https://zh.mweb.im/asset/img/set-up-git.gif)
Format: ![image description](url)

In MWeb, you can use -w + Number to control image width, for example, set the image width 140px:

MWeb Drawing

mermaid

Mermaid is a popular js graphics library. It supports flowcharts, sequence diagrams and Gantt charts. Its official website is: https://mermaidjs.github.io/. The syntax for using mermaid in MWeb is to declare code blocks. The language is mermaid, and the mermaid drawing syntax can be written in the code block. You can copy the following syntax into MWeb to view the result.

```mermaid
sequenceDiagram
    participant Alice
    participant Bob
    Alice->John: Hello John, how are you?
    loop Healthcheck
        John->John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail...
    John-->Alice: Great!
    John->Bob: How about you?
    Bob-->John: Jolly good!
```

Result：

echarts

Echarts is a js graph library of Baidu. Its website is https://echarts.apache.org/zh/index.html. It is very powerful. MWeb supports some basic usages of echarts. You can try the following syntax to copy it into MWeb. You can also go to the https://echarts.apache.org/examples/zh/index.html URL to see some examples. Note that MWeb can only parse option = {} which is simple but should be enough used.

```echarts
option = {
    xAxis: {
        type: 'category',
        data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
    },
    yAxis: {
        type: 'value'
    },
    series: [{
        data: [820, 932, 901, 934, 1290, 1330, 1320],
        type: 'line'
    }]
};
```

Result：

LaTeX (MathJax rendering)

MWeb uses the native code block syntax in CommonMark to support LaTeX math formulas. The syntax of inline code and code blocks in CommonMark is highly extensible and can be extended at will. MWeb uses ``inline math`` as the inline syntax for math formulas and ```math block math ``` as the block syntax for math formulas. Then `code` is still inline code syntax, and ``inline math`` is also inline code in CommonMark, but will be rendered as math formula in MWeb. The advantage of this is that when the original markdown document is published to an environment that does not support mathematical formulas, it will be displayed in code, so that the original formula text will be displayed and will not affect reading too much.
In addition, MWeb is also compatible with $ and $$ style math formulas. When using math formulas, you need to enable LaTeX math formulas in `Preferences - General' and select the syntax to use.

Comments and read more

Actions->Insert Read More Comment or Command + .
Note The feature of reading more is only used when generating a website or blog. When inserting, pay attention to a blank line.

TOC

Markdown syntax:

[TOC]

Result: