Skip to content

Fix #58: Rename json feature to serde #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 27, 2023
Merged

Fix #58: Rename json feature to serde #59

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3362a7
Add `serde` feature which enables `json` feature
barafael Apr 12, 2023
d83cc64
Merge branch 'main' into main
barafael Apr 26, 2023
7c2d812
Update readme.md
wooorm Apr 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ harness = false

[features]
default = []
json = ["dep:serde", "dep:serde_json"]
json = ["serde"]
serde = ["dep:serde"]
log = ["dep:log"]

[dependencies]
log = { version = "0.4", optional = true }
unicode-id = { version = "0.3", features = ["no_std"] }
serde = { version = "1.0", features = ["derive"], optional = true }
serde_json = { version = "1.0", optional = true }

[dev-dependencies]
env_logger = "0.10"
Expand Down
8 changes: 8 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,14 @@ and a few other structs and enums.

See the [crate docs][docs] for more info.

## Feature Flags

These feature flags are exposed via `cargo`:

* log: enables logging via the [log crate](https://crates.io/crates/log)
* json: enables de/serialization via the [serde crate](https://crates.io/crates/serde)
* serde: enables de/serialization via the [serde crate](https://crates.io/crates/log)

## Extensions

`markdown-rs` supports extensions to `CommonMark`.
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
//!
//! * **`default`**
//! — nothing is enabled by default
//! * **`json`**
//! — enable serde to serialize the AST (includes `dep:serde`, `dep:serde_json`)
//! * **`serde`**
//! — enable serde to serialize the AST (includes `dep:serde`)
//! * **`log`**
//! — enable logging (includes `dep:log`);
//! you can show logs with `RUST_LOG=debug`
Expand Down
Loading