Merge pull request #136 from RaenonX-DL/dev

v2.8.0 Release

.eslintrc.yml

@@ -11,6 +11,15 @@ extends:
   - plugin:eslint-plugin-import/errors
   - plugin:eslint-plugin-import/warnings
   - plugin:eslint-plugin-import/typescript
+  - plugin:@next/next/recommended
+
+plugins:
+  - "@typescript-eslint"
+  - jest-dom
+  - react
+  - react-hooks
+  - testing-library
+  - unused-imports
 
 ignorePatterns:
   - '*.d.ts'
@@ -27,11 +36,6 @@ parserOptions:
   ecmaVersion: 2021
   sourceType: module
 
-plugins:
-  - "@typescript-eslint"
-  - react
-  - unused-imports
-
 rules:
   "@typescript-eslint/no-unused-vars":
     - error
@@ -79,6 +83,9 @@ rules:
   unused-imports/no-unused-imports:
     - error
 
+  '@next/next/no-img-element':
+    - off
+
 settings:
   react:
     version: detect

doc/markdown.md

@@ -0,0 +1,70 @@
+# Markdown Cheatsheet
+
+## Common usage
+
+[Cheatsheet](https://www.markdownguide.org/cheat-sheet/)
+
+## Customized syntax
+
+`[R]` means required.
+`[O]` means optional.
+
+### Text coloring
+
+```
+::[<Color>]<Text>::
+```
+
+- `[R]` `<Color>` can be either RGB as `#707070` or a preset CSS color like `red`.
+- `[R]` `<Text>` is any kind of text.
+
+### Text enlarging
+
+Slightly larger (1.5rem):
+
+```
+!!<Text>!!
+```
+
+Larger (2rem):
+
+```
+!!!<Text>!!!
+```
+
+- `[R]` `<Text>` is any kind of text.
+
+### Image with classes
+
+```
+![<Alt>](<ImageURL>|<ClassNames>)
+```
+
+- `[O]` `<Alt>` is the `alt` attribute for HTML `<img>`.
+- `[R]` `<ImageURL>` is the URL of the image.
+- `[R]` `<ClassNames>` are the css class names to apply onto the image.
+
+#### Available class names
+
+- `unitIcon` is for either character or dragon icon. This will be displayed inline.
+
+### In-text calculation
+
+```
+==([fx])<Expression>([fx])(Decimal)==
+```
+
+Show the expression and the result in 2 decimals at the end:
+
+```
+==<Expression>[fx][2f]==
+```
+
+> Things in the parentheses are optional.
+
+- `[O]` `[fx]` is a constant string representing the placeholder of the calculation expression.
+- `[R]` `<Expression>` is the expression used for the calculation.
+- `[O]` `<Decimal>` is the number of decimals to display.
+  - Either have something like `[2f]` for showing 2 decimals, or omit it all.
+
+> Both `*` and `x` mean multiply.