aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib.rs
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2023-02-10 12:43:38 +0100
committerLibravatar Titus Wormer <tituswormer@gmail.com>2023-02-10 12:43:38 +0100
commit905b62583be73a8969014dbb98b6fd1c92c23df6 (patch)
tree78827305dcb1110ca48c2951c8eae82dc182f268 /src/lib.rs
parent72a8cf99fbd20ab29f4f3c1845c67898cdaff7de (diff)
downloadmarkdown-rs-905b62583be73a8969014dbb98b6fd1c92c23df6.tar.gz
markdown-rs-905b62583be73a8969014dbb98b6fd1c92c23df6.tar.bz2
markdown-rs-905b62583be73a8969014dbb98b6fd1c92c23df6.zip
Add `log` feature, document features
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 143c931..6d19396 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -11,6 +11,17 @@
//! constructs (GFM, MDX, and the like)
//! * [`to_mdast()`][]
//! — turn markdown into a syntax tree
+//!
+//! ## Features
+//!
+//! * **`default`**
+//! — nothing is enabled by default
+//! * **`json`**
+//! — enable serde to serialize the AST (includes `dep:serde`, `dep:serde_json`)
+//! * **`log`**
+//! — enable logging (includes `dep:log`);
+//! you can show logs with `RUST_LOG=debug`
+
#![no_std]
#![deny(clippy::pedantic)]
#![allow(clippy::doc_link_with_quotes)]