Skip to content

Commit

Permalink
doc: add links to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ToruNiina committed Jun 16, 2024
1 parent 24b24d7 commit 717c2d8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![License](https://img.shields.io/github/license/ToruNiina/toml11.svg?style=flat)](LICENSE)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1209136.svg)](https://doi.org/10.5281/zenodo.1209136)

[日本語版](https://github.com/ToruNiina/toml11/README_ja.md)
[日本語版](https://github.com/ToruNiina/toml11/blob/main/README_ja.md)

toml11 is a feature-rich TOML language library for C++.

Expand Down Expand Up @@ -70,7 +70,7 @@ int main()
}
```

For more details, please refer to the documentation.
For more details, please refer to the [documentation](https://toruniina.github.io/toml11/).

## Table of Contents

Expand All @@ -89,7 +89,7 @@ For more details, please refer to the documentation.

There are several ways to use toml11.

Here is a brief overview of each method. For more details, please refer to the documentation.
Here is a brief overview of each method. For more details, please refer to the [documentation](https://toruniina.github.io/toml11/docs/installation/).

### Single Include File

Expand Down Expand Up @@ -147,7 +147,7 @@ $ cmake --build ./build/

Here is a brief overview of the features provided by toml11.

For more details, please refer to the documentation.
For more details, please refer to the [documentation](https://toruniina.github.io/toml11/docs/features/).

### Parsing a File

Expand Down Expand Up @@ -198,7 +198,7 @@ s.ext_null_value = true; // this allows `key = null` value
s.ext_num_suffix = true; // this allows numeric suffixes like `100_msec`
```

For more detail and reference of each feature, please refer to the documentation.
For more detail and reference of each feature, please refer to the [documentation](https://toruniina.github.io/toml11/docs/features/).

### finding a value

Expand Down Expand Up @@ -237,7 +237,7 @@ const auto mixed = toml::find<
>(input, "mixed_array") << std::endl;
```

For more details, please refer to the documentation.
For more details, please refer to the [documentation](https://toruniina.github.io/toml11/docs/features/value/).

### comments

Expand Down Expand Up @@ -265,7 +265,7 @@ std::cout << input.at("a").comments().size() << std::endl;
std::cout << input.at("a").comments().at(0) << std::endl;
```

For more details, please refer to the documentation.
For more details, please refer to the [documentation](https://toruniina.github.io/toml11/docs/features/value/#accessing-comments).

### error messages

Expand Down Expand Up @@ -307,7 +307,7 @@ if(a.as_integer() < 0)
}
```

For more details, please refer to the documentation.
For more details, please refer to the [documentation](https://toruniina.github.io/toml11/docs/features/error_message/).

### serialization

Expand All @@ -328,7 +328,7 @@ output.at("a").as_integer_fmt().spacer = 4;
std::cout << toml::format(input) << std::endl;
```
For details on possible formatting specifications, please refer to the documentation.
For details on possible formatting specifications, please refer to the [documentation](https://toruniina.github.io/toml11/docs/features/serialize/).
### configuring types
Expand Down
16 changes: 8 additions & 8 deletions README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ int main()
}
```

詳細な機能とリファレンスに関しては、ドキュメントを参照してください
詳細な機能とリファレンスに関しては、[ドキュメント](https://toruniina.github.io/toml11/ja/)を参照してください

## Table of Contents

Expand All @@ -86,7 +86,7 @@ int main()

toml11を使うには複数の方法があります。

ここではそれぞれを短く紹介します。詳細は、ドキュメントを参照してください
ここではそれぞれを短く紹介します。詳細は、[ドキュメント](https://toruniina.github.io/toml11/ja/docs/installation/)を参照してください

### Single include file

Expand Down Expand Up @@ -146,7 +146,7 @@ $ cmake --build ./build/

ここでは、toml11の持つ機能を短く紹介します。

詳細についてはドキュメントを参照してください
詳細については[ドキュメント](https://toruniina.github.io/toml11/ja/docs/features/)を参照してください

### parsing a file

Expand Down Expand Up @@ -197,7 +197,7 @@ s.ext_null_value = true; // 空の値 `null` を許可
s.ext_num_suffix = true; // `100_msec`などのsuffixを許可
```

各機能の紹介とリファレンスは、ドキュメントを参照してください
各機能の紹介とリファレンスは、[ドキュメント](https://toruniina.github.io/toml11/ja/docs/features/)を参照してください

### finding a value

Expand Down Expand Up @@ -236,7 +236,7 @@ const auto mixed = toml::find<
>(input, "mixed_array") << std::endl;
```

詳細についてはドキュメントを参照してください
詳細については[ドキュメント](https://toruniina.github.io/toml11/ja/docs/features/value/)を参照してください

### comments

Expand All @@ -263,7 +263,7 @@ std::cout << input.at("a").comments().size() << std::endl;
std::cout << input.at("a").comments().at(0) << std::endl;
```

詳細についてはドキュメントを参照してください
詳細については[ドキュメント](https://toruniina.github.io/toml11/ja/docs/features/value/#%E3%82%B3%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AB%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E3%81%99%E3%82%8B)を参照してください

### error messages

Expand Down Expand Up @@ -305,7 +305,7 @@ if(a.as_integer() < 0)
}
```

詳細はドキュメントを参照してください
詳細は[ドキュメント](https://toruniina.github.io/toml11/ja/docs/features/error_message/)を参照してください

### serialization

Expand All @@ -327,7 +327,7 @@ output.at("a").as_integer_fmt().spacer = 4;
std::cout << toml::format(input) << std::endl;
```
どのような指定が可能かなどの詳細はドキュメントを参照してください
どのような指定が可能かなどの詳細は[ドキュメント](https://toruniina.github.io/toml11/ja/docs/features/serialize/)を参照してください
### configuring types
Expand Down

0 comments on commit 717c2d8

Please sign in to comment.