summaryrefslogtreecommitdiff
path: root/man
AgeCommit message (Collapse)Author
2015-12-22Separate parsing and rendering opts in cmark.h.John MacFarlane
This change also changes some of these constants' numerical values, but nothing should change in the API if you use the constants themselves. It should now be clear in the man page which options affect parsing and which affect rendering. Closes #88.
2015-12-22Rename hrule -> thematic_break.John MacFarlane
CMARK_NODE_HRULE -> CMARK_NODE_THEMATIC_BREAK. However we've defined the former as the latter to keep backwards compatibility. See jgm/CommonMark 8fa94cb460f5e516b0e57adca33f50a669d51f6c
2015-12-22Rename 'header' -> 'heading'.John MacFarlane
See jgm/CommonMark commit 0cdbcee4e840abd0ac7db93797b2b75ca4104314 Note that we have defined cmark_node_get_header_level = cmark_node_get_heading_level and cmark_node_set_header_level = camrk_node_set_heading_level for backwards compatibility in the API.
2015-12-19Updated API docs; getters return empty strings if not set.John MacFarlane
rather than NULL, as previously documented...
2015-12-19Changed API for CUSTOM_BLOCK and CUSTOM_INLINE.John MacFarlane
Instead of using their `as.literal` content, we now give each custom node *two* literal fields, one to be printed on entering the node (before rendering the children, if any), the other on exiting (after rendering children). This gives us the flexibility to have custom nodes with children.
2015-12-19Rename RAW_BLOCK -> CUSTOM_BLOCK, RAW_INLINE -> CUSTOM_INLINE.John MacFarlane
2015-12-19Added RAW_BLOCK and RAW_INLINE node types.John MacFarlane
These are passed through verbatim by all writers, with no escaping. They are never generated by the parser, and do not correspond to CommonMark elements. They are designed to be inserted by filters that postprocess the AST. For example, a filter might convert specially marked code blocks to svg diagrams in HTML and tikz diagrams in LaTeX, passing these through to the renderer as a RAW_BLOCK.
2015-10-28Correct string length in cmark_parse_document example.Lee Jeffery
2015-08-07cmark.3 man page - regenerated with smart.John MacFarlane
2015-07-27Use clang-format, llvm style, for formatting.John MacFarlane
* Reformatted all source files. * Added 'format' target to Makefile. * Removed 'astyle' target. * Updated .editorconfig.
2015-07-13Added `CMARK_OPT_SAFE` option and `--safe` command-line flag.John MacFarlane
* Added `CMARK_OPT_SAFE`. This option disables rendering of raw HTML and potentially dangerous links. * Added `--safe` option in command-line program. * Updated `cmark.3` man page. * Added `scan_dangerous_url` to scanners. * In HTML, suppress rendering of raw HTML and potentially dangerous links if `CMARK_OPT_SAFE`. Dangerous URLs are those that begin with `javascript:`, `vbscript:`, `file:`, or `data:` (except for `image/png`, `image/gif`, `image/jpeg`, or `image/webp` mime types). * Added `api_test` for `OPT_CMARK_SAFE`. * Rewrote `README.md` on security.
2015-07-12cmark.3 - fixed botched escaping.John MacFarlane
2015-07-12Limit generated man page to 72 character line width.John MacFarlane
2015-07-12Added width parameter to render_man.John MacFarlane
Rewrote man.c using new renderer framework.
2015-07-05Added LaTeX renderer.John MacFarlane
* New exported function in API: `cmark_render_latex`. * Added src/latex.hs. * Updated README and man page. * Closes #31.
2015-06-25Changed version variables to functions.Andrius Bentkus
This is easier to access using ffi, since some languages, like C# like to use only function interfaces for accessing library functionality. fixes #60
2015-06-16Added `CMARK_OPT_VALIDATE_UTF8` option.John MacFarlane
Also command line option `--validate-utf8`. This option causes cmark to check for valid UTF-8, replacing invalid sequences with the replacement character, U+FFFD. Reinstated api tests for utf8.
2015-06-07Switch cmark_markdown_to_html over to size_tNick Wellnhofer
2015-03-30Updated man page.John MacFarlane
2015-03-21CommonMark renderer: Added 'width' parameter.John MacFarlane
This controls column width for hard wrapping. By default it is 0, which means that no wrapping will be done. Added a width parameter in `cmark_render_commonmark`.
2015-03-21Updated output formats in man page.John MacFarlane
Closes #16.
2015-03-21Added commonmark renderer.John MacFarlane
This is still incomplete. (See TODOs in the source.)
2015-03-15Added options parameter to cmark_markdown_to_html.John MacFarlane
2015-03-09cmark.h: Add argument to cmark_parser_new.John MacFarlane
This was a bug; the function does take an argument. Oddly, gcc and clang did not complain. Closes #12.
2015-02-16Rename CMARK_OPT_SMARTPUNCT -> CMARK_OPT_SMART.John MacFarlane
2015-02-16Made 'options' an int rather than a long.John MacFarlane
For consistency with the API.
2015-02-15Removed outdated statement in man page.John MacFarlane
`--smart` now affects XML output too.
2015-02-15Added options parameter to cmark_parse_document, cmark_parse_file.John MacFarlane
Also to some non-exported functions in blocks and inlines.
2015-02-15Man page updates.John MacFarlane
2015-02-15Implemented --smart for man output.John MacFarlane
2015-02-14Updated man page for --smart.John MacFarlane
2015-02-14Added CMARK_OPT_SMARTPUNCT and --smart option.John MacFarlane
So far this is only implemented for the HTML renderer. Ultimately some of this should be factored out into a form that can be used in other renderers.
2015-01-28Update cmark.3 man page.John MacFarlane
Only the date changed, but this is needed to avoid building the page on a git checkout.
2015-01-23Let cmake update versionNick Wellnhofer
Add a new template cmark_version.h.in to generate cmark_version.h containing version information.
2015-01-23Improve version informationNick Wellnhofer
Add version number and string as macros and symbols. Version numbers can be easily compared, for example in the C preprocessor: #include <cmark.h> #if CMARK_VERSION < 0x020200 #error Requires libcmark 2.2.0 or higher #endif Storing the version in a global variable allows to check the library version at runtime. For example: if (CMARK_VERSION != cmark_version) { warn("Compiled against libcmark %s, but using %s", CMARK_VERSION_STRING, cmark_version_string); } The version should be updated whenever the public API is changed.
2015-01-20Accessor for iterator's root nodeNick Wellnhofer
2015-01-20Add user data field for nodesNick Wellnhofer
2015-01-11Added cmark.3 man page to repository and archive.John MacFarlane
It simplifies the build if python and the cmark library aren't needed to build the man page. The top level Makefile has a rule to regenerate this when src/cmark.h changes. Updated Makefile.nmake for recent changes. Added case folding data file to archive, since otherwise make fails.
2015-01-11Small reorganization of man/CMakeLists.txt.John MacFarlane
Don't add install targets if on Windows.
2015-01-11Make sure library is built before man page.John MacFarlane
Closes #279.
2015-01-07cmark: Add function & option to normalize text nodes.John MacFarlane
So, instead of <text>Hi</text> <text>&amp;</text> <text>lo</text> we get <text>Hi&amp;lo</text> * Added exported `cmark_consolidate_text_nodes` function. * Added `CMARK_OPT_NORMALIZE` to options. * Added optional normalization in XML writer. * Added `--normalize` option to command-line program. * Updated man page.
2014-12-29Fixed md2man for python3.John MacFarlane
Partially addresses #254. This change makes make_man_page.py work with either python3 or python2. The test suite is still dependent on python2, and this should be changed, but for now this at least makes a build possible.
2014-12-26Use python, not python2, as name of python interpreter.John MacFarlane
Partially reverts ba8f2c48b700a466a8cf7097d5f72d43372d4c37. See #251.
2014-12-24Use python2 for man, test scripts.John MacFarlane
Closes #251.
2014-12-24Fixed make_man_page.py so it works with both python2 and python3.John MacFarlane
Closes #251.
2014-12-17Create cmark.3 in cmake build process.John MacFarlane
Remove it from the repository. Closes #241.
2014-12-16Added 'literal' field to 'code' struct.John MacFarlane
In the last few commits we were using as.code.fenced and as.literal at the same time for NODE_CODE_BLOCK, which obviously led to problems.
2014-12-15Re-added cmark_ prefix to strbuf and chunk.John MacFarlane
Reverts 225d720.
2014-12-14Rename get/set_string_content -> get/set_literal.John MacFarlane
2014-12-14man writer: use chunk literal in code blocks.John MacFarlane