VienDesu/schemars
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update just-the-docs and feature flags docs

Browse source
This commit is contained in:
Graham Esau 2024-08-20 23:09:19 +01:00
parent 8fa61b09a4
commit 564a5d8ae4
3 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/4-features.md
View file

@ -6,6 +6,7 @@ permalink: /features/
# Feature Flags and Optional Dependencies # Feature Flags and Optional Dependencies
- `std` (enabled by default) - implements `JsonSchema` for types in the rust standard library (`JsonSchema` is still implemented on types in `core` and `alloc`, even when this feature is disabled). Disable this feature to use schemars in `no_std` environments.
- `derive` (enabled by default) - provides `#[derive(JsonSchema)]` macro - `derive` (enabled by default) - provides `#[derive(JsonSchema)]` macro
- `preserve_order` - keep the order of struct fields in `Schema` properties - `preserve_order` - keep the order of struct fields in `Schema` properties
- `raw_value` - implements `JsonSchema` for `serde_json::value::RawValue` (enables the serde_json `raw_value` feature) - `raw_value` - implements `JsonSchema` for `serde_json::value::RawValue` (enables the serde_json `raw_value` feature)

2
docs/Gemfile
View file

@ -10,7 +10,7 @@ source "https://rubygems.org"
# gem "jekyll", "~> 4.0.0" # gem "jekyll", "~> 4.0.0"
# This is the default theme for new Jekyll sites. You may change this to anything you like. # This is the default theme for new Jekyll sites. You may change this to anything you like.
# gem "minima", "~> 2.5" # gem "minima", "~> 2.5"
gem "just-the-docs", "= 0.8.2" gem "just-the-docs", "= 0.9.0"
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`. # uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", group: :jekyll_plugins gem "github-pages", group: :jekyll_plugins

2
docs/_config.yml
View file

@ -27,7 +27,7 @@ url: "https://graham.cool" # the base hostname & protocol for your site, e.g. ht
permalink: pretty permalink: pretty
# Build settings # Build settings
remote_theme: pmarsceill/just-the-docs@v0.8.2 remote_theme: pmarsceill/just-the-docs@v0.9.0
markdown: CommonMarkGhPages markdown: CommonMarkGhPages
commonmark: commonmark:
options: ["UNSAFE", "FOOTNOTES"] options: ["UNSAFE", "FOOTNOTES"]