MultiMarkdown-6

授权协议 View license
开发语言
所属分类 企业应用、 LaTeX排版系统
软件类型 开源软件
地区 不详
投 递 者 郜光明
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

About

Title: libMultiMarkdown
Author: Fletcher T. Penney
Date: 2020-10-28
Copyright: Copyright © 2016 - 2020 Fletcher T. Penney.
Version: 6.6.0

master branch:
develop branch:

An Announcement!

MultiMarkdown v6 is finally here! If you want more information abouttesting, see DevelopmentNotes.

If you want to more know about the differences from v5, see the QuickStartguide.

Obtaining MultiMarkdown

You can download the latest installer for MacOS or Windows at Github:

https://github.com/fletcher/MultiMarkdown-6/releases

To build from source, download from Github. Then:

make release
(OR)
make debug

cd build
make

You can optionally test using the test suite:

ctest

Xcode

In order to use libMultiMarkdown in your Xcode project:

  1. cd into the root of your Xcode project folder (where the .xcodeproj fileresides).

  2. Add this project as a git submodule:

    git submodule add https://github.com/fletcher/MultiMarkdown-6 MultiMarkdown-6
    
  3. Compile:

    cd MultiMarkdown-6
    make xcode
    
  4. Drag the build-xcode/MultiMarkdown.xcodeproj file to the root of yourXcode project as a subproject.

  5. Select the MultiMarkdown subproject, select the libMultiMarkdown target,and in Build Phases > Copy Files select Products Directory from theDestination popup menu.

  6. Select your root project, select your target, add libMultiMarkdown underTarget Depencies and libMultiMarkdown.framework/libMultiMarkdown andlibcurl.tdb under Link Binary with Libraries.

Warning: if you move the project on disk or update the MultiMarkdown sourcefiles, you need to rerun step 3 above.

You can now #import <libMultiMarkdown/libMultiMarkdown.h>. To get you started,here is (untested) demonstration code that converts a NSString to HTML:

token_pool_init(); // needs to be done once per app lifecycle - PLEASE READ token.h!!!!!!!!!!!

NSString *input = @"Test *string* for **demonstration**.";
const char *cString = [input cStringUsingEncoding:NSUTF8StringEncoding];
const char *mmd = mmd_string_convert(cString, EXT_SMART | EXT_NOTES | EXT_CRITIC | EXT_TRANSCLUDE, FORMAT_HTML, ENGLISH);
NSString *output = [[NSString alloc] initWithCString:mmd encoding:NSUTF8StringEncoding];

// Cleanup
free(mmd); 
token_pool_drain();		// again, PLEASE READ token.h!!!!!!
token_pool_free();

There are 3 main versions of the primary functions:

  • mmd_string...: start from source text in c string
  • mmd_d_string...: start from a DString (Useful if you already use DString's for your text)
  • mmd_engine...: useful when you are processing the same source multiple times

The C string variants are as follows:

// Convert OPML string to MMD
DString * mmd_string_convert_opml_to_text(const char * source);

// Convert ITMZ string to MMD
DString * mmd_string_convert_itmz_to_text(const char * source);

// Convert MMD text to specified format, with specified extensions, and language
// Returned char * must be freed
char * mmd_string_convert(const char * source, unsigned long extensions, short format, short language);

// Convert MMD text to specified format using DString as a container for block of data
// and length of that block.  Must be used for "complex" output formats such as EPUB.
// Returned DString * must be freed
DString * mmd_string_convert_to_data(const char * source, unsigned long extensions, short format, short language, const char * directory);

// Convert MMD text and write results to specified file -- used for "complex" output formats requiring
// multiple documents (e.g. EPUB)
void mmd_string_convert_to_file(const char * source, unsigned long extensions, short format, short language, const char * directory, const char * filepath);

// Does the text have metadata?
bool mmd_string_has_metadata(char * source, size_t * end);

// Return metadata keys, one per line
// Returned char * must be freed
char * mmd_string_metadata_keys(char * source);

// Extract desired metadata as string value
// Returned char * must be freed
char * mmd_string_metavalue_for_key(char * source, const char * key);

// Insert/replace metadata in string, returning new string
char * mmd_string_update_metavalue_for_key(const char * source, const char * key, const char * value);

// Grab list of all transcluded files, but we need to know directory to search,
// as well as the path to the file
// Returned stack needs to be freed
struct stack * mmd_string_transclusion_manifest(const char * source, const char * search_path, const char * source_path);

The following enums can be used for the parameters language, format and extensions:

enum smart_quotes_language {
	ENGLISH = 0,
	DUTCH,
	FRENCH,
	GERMAN,
	GERMANGUILL,
	SPANISH,
	SWEDISH,
};

enum output_format {
	FORMAT_HTML,
	FORMAT_EPUB,
	FORMAT_LATEX,
	FORMAT_BEAMER,
	FORMAT_MEMOIR,
	FORMAT_FODT,
	FORMAT_ODT,
	FORMAT_TEXTBUNDLE,
	FORMAT_TEXTBUNDLE_COMPRESSED,
	FORMAT_OPML,
	FORMAT_ITMZ,
	FORMAT_MMD,
};

enum parser_extensions {
	EXT_COMPATIBILITY       = 1 << 0,    //!< Markdown compatibility mode
	EXT_COMPLETE            = 1 << 1,    //!< Create complete document
	EXT_SNIPPET             = 1 << 2,    //!< Create snippet only
	EXT_SMART               = 1 << 3,    //!< Enable Smart quotes
	EXT_NOTES               = 1 << 4,    //!< Enable Footnotes
	EXT_NO_LABELS           = 1 << 5,    //!< Don't add anchors to headers, etc.
	EXT_PROCESS_HTML        = 1 << 6,    //!< Process Markdown inside HTML
	EXT_NO_METADATA         = 1 << 7,    //!< Don't parse Metadata
	EXT_OBFUSCATE           = 1 << 8,    //!< Mask email addresses
	EXT_CRITIC              = 1 << 9,    //!< Critic Markup Support
	EXT_CRITIC_ACCEPT       = 1 << 10,   //!< Accept all proposed changes
	EXT_CRITIC_REJECT       = 1 << 11,   //!< Reject all proposed changes
	EXT_RANDOM_FOOT         = 1 << 12,   //!< Use random numbers for footnote links
	EXT_TRANSCLUDE          = 1 << 13,   //!< Perform transclusion(s)
	EXT_PARSE_OPML          = 1 << 14,   //!< Convert from OPML before processing source text
	EXT_PARSE_ITMZ			= 1 << 15,   //!< Convert from ITMZ (iThoughts) before processing source text
	EXT_RANDOM_LABELS		= 1 << 16,   //!< Use random numbers for header labels (unless manually defined)
	EXT_FAKE                = 1 << 31,   //!< 31 is highest number allowed
};

Differences in the MultiMarkdown Syntax

MultiMarkdown v6 is mostly about making a better MMD parser, but it involves afew changes to the MultiMarkdown syntax itself.

  1. Setext headers can consist of more than one line to be included in theheader:

    This is
    a header
    ========
    
  2. Whitespace is not allowed between the text brackets and label brackets inreference links, images, footnotes, etc. For example [foo] [bar] will nolonger be the same as [foo][bar].

  3. Link and image titles can be quoted with 'foo', "foo", or (foo).Link attributes can be used in both reference and inline links/images.

  4. HTML elements are handled slightly differently. There is no longer amarkdown="1" feature. Instead, HTML elements that are on a line bythemselves will open an HTML block that will cause the rest of the "paragraph"to be treated as HTML such that Markdown will not be parsed in side of it.HTML block-level tags are even "stronger" at starting an HTML block. It isnot quite as complex as the approach used in CommonMark, but is similar undermost circumstances. Leaving a blank line after the opening tag will allowMultiMarkdown parsing inside of the HTML block.

    For example, this would not be parsed:

    <div>
    *foo*
    </div>
    

    But this would be:

    <div>
    
    *foo*
    
    </div>
    
  5. "Malformed" reference link definitions are handled slightly differently.For example, the test suite file Reference Footnotes.text is parseddifferently in compatibility mode than MMD-5. This started as a side-effectof the parsing algorithm, but I actually think it makes sense. This may ormay not change in the future.

  6. Table captions in MMD-6 must come immediately after the table, notbefore it.

  7. Escaped linebreaks (\ preceding a line break) will be interpreted as<br /> (even in compatibility mode). This was previously an optionalfeature in MMD, but I don't see a problem with just making it defaultbehavior.

  8. Escaped spaces (\ ) will be interpreted as a non-breaking space, if theoutput format supports it.

  9. CriticMarkup, Abbreviations, Glossary Terms, and Citations are handledslightly differently. See the QuickStart guide for more information.

  10. Fenced code blocks can use leading/trailing "fences" of 3, 4, or 5backticks in length. That should be sufficient for complex documents withoutrequiring a more complex parser. If there is no trailing fence, then thefenced block is considered to go through the end of the document.

  11. Emph and Strong parsing is conceptually the same, but the implementationis different. It is designed for speed, accuracy, and consistency. Ingeneral, it seems to handle edge cases much more reliably, but there are stilla couple of situations that I would like to take into account, if possible.These are not situations that should occur often in "real life."

  12. EPUB 3 output is supported without need of any external tools.

  13. Internationalization support for HTML phrases, such as "see footnote". SeeGithub for moreinformation.

License

The `MultiMarkdown 6` project is released under the MIT License..

GLibFacade.c and GLibFacade.h are from the MultiMarkdown v4 project:

	https://github.com/fletcher/MultiMarkdown-4/

MMD 4 is released under both the MIT License and GPL.


CuTest is released under the zlib/libpng license. See CuTest.c for the
text of the license.

uthash library:
	Copyright (c) 2005-2016, Troy D. Hanson

	Licensed under Revised BSD license

miniz library:
	Copyright 2013-2014 RAD Game Tools and Valve Software
	Copyright 2010-2014 Rich Geldreich and Tenacious Software LLC

	Licensed under the MIT license

argtable3 library:
	Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann
	<sheitmann@users.sourceforge.net>
	All rights reserved.

	Licensed under the Revised BSD License


## The MIT License ##

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


## Revised BSD License ##

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.
    * Neither the name of the <organization> nor the
      names of its contributors may be used to endorse or promote
      products derived from this software without specific prior
      written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT
HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES LOSS OF USE, DATA, OR
PROFITS OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • 背景:markdown编辑有很多,我用过markdownpad,markdown editor,stackedit.前面两个根本不好用,stackedit是稍为好的,但是是网页版,离线的体现也不好.于是再寻找替代者,IJ里面的插件也有几个,但觉得multimarkdown最好.当然要依赖IJ(IntelliJ IDEA),WS(IntelliJ Webstorm)也是不好的.但我能在IDE结合GI

  • 經常看著單色的Plain Text 不免乏味,找起東西來也麻煩。 TextMate 裡面的語法高亮不能這麼平白浪費了。 支持列表中的 textile 和 Markdown 還是蠻熟悉的。 簡單了解下還是選擇使用MultiMarkdown 了。 http://en.wikipedia.org/wiki/Textile Textile vs Markdown MultiMarkdown     使用教

 相关资料
  • 问题内容: 我最近卸载了Java 8,以使用Java 6,因为我希望我的代码/创建内容可以被更多的人使用,而不仅仅是Java 8上的人。当我这样做时,它会返回: 当我这样做时: Java似乎一切正常,但是当我尝试运行可执行JAR时也会发生这种情况。我通过手动执行java -jar(jar名称)解决了它 问题答案: 根据maven网站的说法,支持Java 6的最新版本是3.2.5,并且3.3和更高版

  • 问题内容: 是否有任何变通办法可以使Flex编译器与64位JRE一起使用?如果我在Eclipse的Ant构建文件中使用MXMLC任务,则工作正常,但如果我尝试从命令行使用MXMLC(或在Eclipse中从FDT尝试运行…命令),它将失败,告诉我… “错误加载:C:\ Program Files \ Java \ jrrt-1.6.0 \ jre \ bin \ jrockit \ jvm.dll”

  • 问题内容: 我有一个名为@Pojo的自定义注释,可用于自动生成Wiki文档: 我这样使用它: 注释资源方法,以便注释处理器可以自动生成描述所需资源和类型的Wiki页面。 我需要在注释处理器中读取该字段的值,但出现运行时错误。 在我的处理器的源代码中,我有以下几行: 但实际的类不适用于处理器。我认为我需要一个替代品来代替实际课程。我不确定该怎么买。 我得到的错误是: 该是我的一个提到的一类注释。 不

  • 问题内容: 我的特定问题与JDK 1.6中使用的JMX有关:如果我正在通过JRE 1.6运行Java进程 在命令行中,Java是否为远程JMX连接选择默认端口? 背景:我目前正在尝试开发一个过程,以提供给客户,使他们能够通过远程机器上的JMX连接到我们的流程之一。目的是帮助他们对实时显示控制台上发生的情况进行远程调试。由于他们的服务水平协议,他们强烈地希望捕获尽可能多的数据,并且如果情况看起来太复

  • 问题内容: 最近,我注意到声明包含64个元素的数组比声明具有65个元素的相同类型的数组要快得多(> 1000倍)。 这是我用来测试的代码: 这将运行在大约6毫秒,如果我更换用它需要大约7秒。如果作业分布在越来越多的线程中,那么这个问题就会成倍地恶化,这就是我的问题所在。 不同类型的数组(例如或)也会发生此问题。大字符串不会发生此问题:,但将其更改为时确实会发生 我想知道为什么会这样,是否有可能规避

  • 问题内容: 我正在尝试在Windows 8 64Bit和SWT 4.3 64Bit下创建SWT.MOZILLA类型的SWT浏览器小部件。 根据此,SWT 4.3应支持XULRunner的10.x的或24.x 64位版本 因此,我从此处下载了10.x和24.x 64版本,并分别在和下解压缩。 如果我启动指向xulrunner10的Java应用程序(使用VM参数),则它可以工作,但是,如果我尝试使用x