summaryrefslogtreecommitdiff
path: root/man
AgeCommit message (Collapse)Author
2020-02-11Update date on cmark.1.John MacFarlane
2020-02-11cmark.1 - Document --unsafe instead of --safe.John MacFarlane
Closes #332.
2020-02-11cmark.1: remove docs for `--normalize` which no longer exists.John MacFarlane
See #332
2020-02-09Add cmark_get_default_mem_allocator().John MacFarlane
API change: This adds a new exported function in cmark.h. Closes #330.
2020-01-02build: improve man page installationSaleem Abdulrasool
man pages are extremely useful, but are not generally available on Windows. This changes the install condition to check for the Windows cross-compile rather than the toolchain in use. It is possible to build for Windows using clang in the GNU driver.
2020-01-02build: only include GNUInstallDirs onceSaleem Abdulrasool
Avoid including the utility once, which should avoid some unnecessary CMake checks, and reduces duplication.
2019-03-19Define CMARK_OPT_SAFE for API compatibility.John MacFarlane
It doesn't do anything; this is documented.
2019-03-17Make rendering safe by default.John MacFarlane
Removes CMARK_OPT_SAFE from options. Adds CMARK_OPT_UNSAFE, with the opposite meaning. The new default behavior is to suppress raw HTML and potentially dangerous links. The CMARK_OPT_UNSAFE option has to be set explicitly to prevent this. -------------------------------------------------------- NOTE: This change will require modifications in bindings for cmark and in most libraries and programs that use cmark. -------------------------------------------------------- Closes #239, #273. Borrows heavily from @kivikakk's patch in github/cmark-gfm#123.
2017-06-02Merge pull request #195 from github/revert-194-upstream/remove-normalizeJohn MacFarlane
Revert "Remove normalize as an option per #190"
2017-06-02Document cases where get_ functions return NULL.John MacFarlane
E.g. cmark_node_get_url on a non-link or image. Closes #155.
2017-05-07Re-add CMARK_OPT_NORMALIZE without effect.Yuki Izumi
2017-05-05Remove normalize as an option per #190 (#194)Yuki Izumi
2017-01-03Revert "Update cmark.3 man page."John MacFarlane
This reverts commit 26182bb868d3da7dd8a3389729bea79d489855b7.
2016-12-30Update cmark.3 man page.John MacFarlane
2016-11-18Update man 3 page.John MacFarlane
2016-09-13Regenerated cmark.3 man page.John MacFarlane
2016-06-23Updated man page cmark.3.John MacFarlane
2016-06-06mem: Rename the new APIsVicent Marti
2016-06-06mem: Add a `realloc` pointer to the memory handlerVicent Marti
2016-06-06cmark: Implement support for custom allocatorsVicent Marti
2016-05-14Better documentation of memory-freeing responsibilities.John MacFarlane
in cmark.h and its man page. Closes #124.
2016-04-26Clarify that it's the caller's responsibility to free the buffer...John MacFarlane
returned by cmark_render_html etc. Closes #124.
2016-04-09Fixed a number of issues relating to line wrapping.John MacFarlane
- Extend CMARK_OPT_NOBREAKS to all renderers and add `--nobreaks`. - Do not autowrap, regardless of width parameter, if CMARK_OPT_NOBREAKS is set. - Fixed CMARK_OPT_HARDBREAKS for LaTeX and man renderers. - Ensure that no auto-wrapping occurs if CMARK_OPT_NOBREAKS is enabled, or if output is CommonMark and CMARK_OPT_HARDBREAKS is enabled. - Updated man pages.
2016-03-26Open files in binary modeNick Wellnhofer
Now that cmark supports different line endings, files must be openend in binary mode on Windows. Fixes issue #113.
2016-03-24Updated date in man1 page.John MacFarlane
2016-03-24Updated man 3 page.John MacFarlane
2016-03-23Regenerated cmark.3 man page.John MacFarlane
2016-03-20Fixed documentation of --width in man page.John MacFarlane
2016-02-28Fix installation dir of man-pages on NetBSDKamil Rytarowski
2016-02-05Fixed tabs in indentation.John MacFarlane
Closes #101. This patch fixes `S_advance_offset` so that it doesn't gobble a tab character when advancing less than the width of a tab.
2016-01-11cmark_node_replace - unlink, but don't free, oldnode.John MacFarlane
2016-01-11Regenerated cmark.3 man page.John MacFarlane
Now it contains typedefs again.
2016-01-11Fixed make_man_page.py so it includes typedefs again.John MacFarlane
2016-01-10Added cmark_node_replace(oldnode, newnode).John MacFarlane
API change. I've found in using the API that this is very often wanted.
2015-12-28Rename NODE_HTML -> NODE_HTML_BLOCK, NODE_INLINE_HTML -> NODE_HTML_INLINE.John MacFarlane
API change. Sorry, but this is the time to break things, before 1.0 is released. This matches the recent changes to CommonMark.dtd.
2015-12-23Added parens around expressions like 1 << 1.John MacFarlane
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.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-19 19:29:48 +0000