docs gen

README.md

@@ -10,8 +10,8 @@ Fuji is a minecraft mod that provides many essential and useful modules for vani
 # Feature
 1. **Vanilla-Respect**: all the modules are designed to be as light-way as possible, and do the least change to the vanilla game. (Never touch the game-logic.)
 2. **Fully-Modular**: you can disable any module completely if you don't like it. (Code is data is code. Thanks to the power of meta-programming, the module loader will even not load and inject the module codes into the game, if you disable the module, without any performance issue.)
-3. **High-Performance**: code is faster just because it is literal shorter. (From data-structure, algorithm, lazy-load and cache to improve performance greatly.)
-4. **Easy-to-Use**: a text-based per-field-explained auto-generated always-up-to-date documentation is provided. (Our configuration use lots of mini-language and generator to provide a unified setup.)
+3. **High-Performance**: code is faster just because it is literal shorter. (And from data-structure, algorithm, lazy-load and cache to improve performance greatly.)
+4. **Easy-to-Use**: a text-based per-field-explained auto-generated always-up-to-date documentation is provided. (Our configuration use lots of mini-language and generators to provide a unified setup.)
 
 # Wiki
 See [configuration](https://github.com/sakurawald/fuji-fabric/wiki/Configuration)

src/main/java/io/github/sakurawald/config/model/ConfigModel.java

@@ -17,6 +17,10 @@
         - You can press `CTRL + F` keys in your keyboard, and search any `configuration key` that you want to konw.
         - If anything is unclear, please create an issue in github.
                 
+        Note:
+        - Most of the configuration files use `.json` file format, so you might want to use a better `text-editor` to highlight the file. 
+          A good editor for json edit is `visual studio code`: [Visual Studio Code - Web Online Editor](https://vscode.dev/)
+          
         """)
 public class ConfigModel {