Skip to content

docs: format markdown docs #2354

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 2 commits into from
Jun 18, 2025
Merged

docs: format markdown docs #2354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6a386a
refine document format
chaokunyang Jun 18, 2025
935b5df
add lint script for markdown
chaokunyang Jun 18, 2025
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: 4 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,5 +327,9 @@ jobs:
uses: actions/setup-python@v5
with:
python-version: 3.8
- name: Use Node.js 20.x
uses: actions/setup-node@v4
with:
node-version: 20.x
- name: Check code style
run: ./ci/run_ci.sh format
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
In addition to cross-language serialization, Fory also features at:

- Drop-in replace Java serialization frameworks such as JDK/Kryo/Hessian, but 100x faster at most, which can greatly improve
the efficiency of high-performance RPC calls, data transfer, and object persistence.
the efficiency of high-performance RPC calls, data transfer, and object persistence.
- **100% compatible** with JDK serialization API with much faster implementation: supporting JDK `writeObject`/`readObject`/`writeReplace`/`readResolve`/`readObjectNoData`/`Externalizable` API.
- Supports **Java 8~21**, Java 17+ `record` is supported too.
- Supports [AOT compilation serialization](docs/guide/graalvm_guide.md) for **GraalVM native image**, and no reflection/serialization json config are needed.
Expand Down Expand Up @@ -417,7 +417,7 @@ Static serialization is relatively secure. But dynamic serialization such as For
For example, the deserialization may invoke `init` constructor or `equals`/`hashCode` method, if the method body contains malicious code, the system will be at risk.

Fory provides a class registration option that is enabled by default for such protocols, allowing only deserialization of trusted registered types or built-in types.
**Do not disable class registration unless you can ensure your environment is secure**.
**Do not disable class registration unless you can ensure your environment is secure**.

If this option is disabled, you are responsible for serialization security. You can configure `org.apache.fory.resolver.ClassChecker` by
`ClassResolver#setClassChecker` to control which classes are allowed for serialization.
Expand Down
4 changes: 4 additions & 0 deletions ci/format.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,10 @@ format_changed() {
git diff --name-only --diff-filter=ACRM "$MERGEBASE" -- '*.ts' | xargs -P 5 \
node ./javascript/node_modules/.bin/eslint
fi
# Install prettier globally
npm install -g prettier
# Fix markdown files
prettier --write "**/*.md"
popd
fi
}
Expand Down
58 changes: 29 additions & 29 deletions dart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,35 +93,35 @@ fory.register($EnumFoo, "example.EnumFoo");

Fory Dart currently supports the following type mappings in XLANG mode:

| Fory Type | Dart Type |
|----------------------------|------------------------------------------------|
| bool | bool |
| int8 | fory.Int8 |
| int16 | fory.Int16 |
| int32 | fory.Int32 |
| var_int32 | fory.Int32 |
| int64 | int |
| var_int64 | int |
| sli_int64 | int |
| float32 | fory.Float32 |
| float64 | double |
| string | String |
| enum | Enum |
| named_enum | Enum |
| named_struct | class |
| list | List |
| set | Set (LinkedHashSet, HashSet, SplayTreeSet) |
| map | Map (LinkedHashMap, HashMap, SplayTreeMap) |
| timestamp | fory.TimeStamp |
| local_date | fory.LocalDate |
| binary | Uint8List |
| bool_array | BoolList |
| int8_array | Int8List |
| int16_array | Int16List |
| int32_array | Int32List |
| int64_array | Int64List |
| float32_array | Float32List |
| float64_array | Float64List |
| Fory Type | Dart Type |
| ------------- | ------------------------------------------ |
| bool | bool |
| int8 | fory.Int8 |
| int16 | fory.Int16 |
| int32 | fory.Int32 |
| var_int32 | fory.Int32 |
| int64 | int |
| var_int64 | int |
| sli_int64 | int |
| float32 | fory.Float32 |
| float64 | double |
| string | String |
| enum | Enum |
| named_enum | Enum |
| named_struct | class |
| list | List |
| set | Set (LinkedHashSet, HashSet, SplayTreeSet) |
| map | Map (LinkedHashMap, HashMap, SplayTreeMap) |
| timestamp | fory.TimeStamp |
| local_date | fory.LocalDate |
| binary | Uint8List |
| bool_array | BoolList |
| int8_array | Int8List |
| int16_array | Int16List |
| int32_array | Int32List |
| int64_array | Int64List |
| float32_array | Float32List |
| float64_array | Float64List |

## Project Structure

Expand Down
1 change: 0 additions & 1 deletion dart/packages/fory-test/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

## Testing Approach

The test suite is inspired by Fory Java's testing approach and includes:
Expand Down
58 changes: 29 additions & 29 deletions dart/packages/fory/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,35 +93,35 @@ fory.register($EnumFoo, "example.EnumFoo");

Fory Dart currently supports the following type mappings in XLANG mode:

| Fory Type | Dart Type |
|----------------------------|------------------------------------------------|
| bool | bool |
| int8 | fory.Int8 |
| int16 | fory.Int16 |
| int32 | fory.Int32 |
| var_int32 | fory.Int32 |
| int64 | int |
| var_int64 | int |
| sli_int64 | int |
| float32 | fory.Float32 |
| float64 | double |
| string | String |
| enum | Enum |
| named_enum | Enum |
| named_struct | class |
| list | List |
| set | Set (LinkedHashSet, HashSet, SplayTreeSet) |
| map | Map (LinkedHashMap, HashMap, SplayTreeMap) |
| timestamp | fory.TimeStamp |
| local_date | fory.LocalDate |
| binary | Uint8List |
| bool_array | BoolList |
| int8_array | Int8List |
| int16_array | Int16List |
| int32_array | Int32List |
| int64_array | Int64List |
| float32_array | Float32List |
| float64_array | Float64List |
| Fory Type | Dart Type |
| ------------- | ------------------------------------------ |
| bool | bool |
| int8 | fory.Int8 |
| int16 | fory.Int16 |
| int32 | fory.Int32 |
| var_int32 | fory.Int32 |
| int64 | int |
| var_int64 | int |
| sli_int64 | int |
| float32 | fory.Float32 |
| float64 | double |
| string | String |
| enum | Enum |
| named_enum | Enum |
| named_struct | class |
| list | List |
| set | Set (LinkedHashSet, HashSet, SplayTreeSet) |
| map | Map (LinkedHashMap, HashMap, SplayTreeMap) |
| timestamp | fory.TimeStamp |
| local_date | fory.LocalDate |
| binary | Uint8List |
| bool_array | BoolList |
| int8_array | Int8List |
| int16_array | Int16List |
| int32_array | Int32List |
| int64_array | Int64List |
| float32_array | Float32List |
| float64_array | Float64List |

## Project Structure

Expand Down
Loading
Loading