add github flavored markdown and reformat accordingly

stac-extensions · Sep 28, 2023 · 5650849 · 5650849
1 parent 1a27543
commit 5650849
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 12 deletions.
diff --git a/.github/remark.yaml b/.github/remark.yaml
@@ -1,4 +1,6 @@
 plugins:
+# GitHub Flavored Markdown
+  - remark-gfm
 # Check links
   - validate-links
 # Apply some recommended defaults for consistency

diff --git a/README.md b/README.md
@@ -26,11 +26,11 @@ The fields in the table below can be used in these parts of STAC documents:
 - [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
 - [ ] Links
 
-| Field Name           | Type                      | Description |
-| -------------------- | ------------------------- | ----------- |
+| Field Name           | Type                      | Description                                  |
+| -------------------- | ------------------------- | -------------------------------------------- |
 | template:new_field   | string                    | **REQUIRED**. Describe the required field... |
-| template:xyz         | [XYZ Object](#xyz-object) | Describe the field... |
-| template:another_one | \[number]                 | Describe the field... |
+| template:xyz         | [XYZ Object](#xyz-object) | Describe the field...                        |
+| template:another_one | \[number]                 | Describe the field...                        |
 
 ### Additional Field Information
 
@@ -42,20 +42,20 @@ This is a much more detailed description of the field `template:new_field`...
 
 This is the introduction for the purpose and the content of the XYZ Object...
 
-| Field Name  | Type   | Description |
-| ----------- | ------ | ----------- |
-| x           | number | **REQUIRED**. Describe the required field... |
-| y           | number | **REQUIRED**. Describe the required field... |
-| z           | number | **REQUIRED**. Describe the required field... |
+| Field Name | Type   | Description                                  |
+| ---------- | ------ | -------------------------------------------- |
+| x          | number | **REQUIRED**. Describe the required field... |
+| y          | number | **REQUIRED**. Describe the required field... |
+| z          | number | **REQUIRED**. Describe the required field... |
 
 ## Relation types
 
 The following types should be used as applicable `rel` types in the
 [Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object).
 
-| Type                | Description |
-| ------------------- | ----------- |
-| fancy-rel-type      | This link points to a fancy resource. |
+| Type           | Description                           |
+| -------------- | ------------------------------------- |
+| fancy-rel-type | This link points to a fancy resource. |
 
 ## Contributing