aboutsummaryrefslogtreecommitdiff
path: root/man
AgeCommit message (Collapse)Author
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
2014-12-14Use as.literal instead of string_content for HTML and code blocks.John MacFarlane
This is for consistency with the other types of nodes that have literal strings as contents.
2014-12-14Rename CMARK_NODE_INLINE_CODE -> CMARK_NODE_CODE.John MacFarlane
2014-12-13Added API documentation to src/cmark.h. Closes #224.John MacFarlane
2014-12-13Makefile fixes for man page.John MacFarlane
Don't build man pages until we've built libcmark, which we need. Also reverted use of typewriter font for signatures; this looks worse in the terminal pager.
2014-12-13Use typewriter font for signatures in man pages.John MacFarlane
2014-12-13Write API docs in cmark.h using markdown.John MacFarlane
`man/make_man_page.py` now converts using cmark.
2014-12-13Added cmark_render_man (man page writer).John MacFarlane
cmark: Replaced `--man` and `--ast` with generic `--to` option.
2014-12-13Added iterator interface to API, removed cmark_walk.John MacFarlane
* Added `iterator.c`, `iterator.h`. * Removed `cmark_walk`. * Replaced `cmark_walk` with iterator in HTML renderer. * Replaced API test for `cmark_walk` with simple iterator test.
2014-12-13API improvements: cmark_event_type parameter for walk handlers.John MacFarlane
Added cmark_event_type enum, which is used as the second parameter of the handler passed to cmark_walk. See #224.
2014-12-13Remove CMARK_NODE_REFERENCE_DEF from API.John MacFarlane
Modified finalize in blocks.c to return parent of finalized block, so we can handle the case of reference definitions, when we simply remove the finalized block.
2014-12-12Revert "Removed CMARK_NODE_REFERENCE_DEF from API."John MacFarlane
This reverts commit b598b52a4acdc2332be3d34e30237d1b93b7dd03. The change led to some problems, because some of the callers of 'finalize' expected the node to exist after the call. This could all be rewritten, but for now let's just revert.
2014-12-12Rudimentary documentation for cmark_walk.John MacFarlane
2014-12-12Removed CMARK_NODE_REFERENCE_DEF from API.John MacFarlane
There's no reason to store these empty nodes in the API. The references have already been resolved.
2014-12-12Added cmark_node_handler and cmark_walk to header.John MacFarlane
2014-12-05Revert "API change: Add cmark_node_set_type for completeness."John MacFarlane
This reverts commit 6c1f76a8a22f6c84231e5101f0950ce353ec8075.
2014-12-05API change: Add cmark_node_set_type for completeness.John MacFarlane
2014-12-05Changed CMARK_NODE_NONE from -1 to 0.John MacFarlane
This is more consistent with CMARK_LIST_NONE, etc.
2014-12-05Added CMARK_NODE_TYPE_NONE.John MacFarlane
This is the return value of cmark_get_node_type when the argument is a null pointer. Avoids segfault.
2014-11-30More man page improvements.John MacFarlane
2014-11-30Fixed commas in man 3 page.John MacFarlane
2014-11-30Make the man pages standard groff man rather than mdoc.John MacFarlane
2014-11-30Fixed bug in splitting arguments in make_man_page.py.John MacFarlane
2014-11-30Switched to mdoc for cmark.1.John MacFarlane
2014-11-30Man page: proper date format.John MacFarlane
2014-11-30Set proper name and section in man page.John MacFarlane
2014-11-30Removed markdown intermediary for man 1 page.John MacFarlane
See #224.
2014-11-30Create man 3 page without markdown intermediary.John MacFarlane
Use proper man style, marking function types, arguments, etc. See #224.
2014-11-30Updated make_man_page.py to use C89 comments.John MacFarlane
See #224. TODO: change this to create the man page directly (not via markdown intermediary) and parse signatures into .Ft, .Fo, .Fa, .Fc, .Fd.
2014-11-30Renamed cmark_parser_push -> cmark_parser_feed.John MacFarlane
2014-11-29Use make_man_page.py + pandoc to create cmark.3 man page from cmark.h.John MacFarlane
See #224.
2014-11-29make_man_page.py improved.John MacFarlane
2014-11-29Added make_man_page.py script.John MacFarlane
2014-11-29Added very basic cmark.3 man page, added to install process.John MacFarlane
This currently just contains a list of functions. It needs some accompanying text, commentary, examples. See #224.