Skip to content

Commit ee0ccc3

Browse files
authored
docs: Fix formatting in README (#141)
1 parent a4f4958 commit ee0ccc3

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ We are using [Conventional Commit messages](https://www.conventionalcommits.org/
66

77
The most important prefixes you should have in mind are:
88

9-
* `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)
9+
- `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)
1010
patch.
11-
* `feat:` which represents a new feature, and correlates to a SemVer minor.
12-
* `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change
11+
- `feat:` which represents a new feature, and correlates to a SemVer minor.
12+
- `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change
1313
(indicated by the `!`) and will result in a SemVer major.
1414

1515
This is the complete list of what is defined and if it is visible in the
1616
changelog:
17+
1718
- 'feat' -> section: 'Features'
1819
- 'feature' -> section: 'Features'
1920
- 'fix' -> section: 'Bug Fixes'
@@ -26,10 +27,10 @@ changelog:
2627
- 'test' -> section: 'Tests', hidden: true
2728
- 'build' -> section: 'Build System', hidden: true
2829
- 'ci' -> section: 'Continuous Integration', hidden: true
29-
```
3030

3131
## 1 Usage
3232

33+
```
3334
Flags:
3435
- `-h, --help`
3536
- `-v, --verbose`
@@ -38,26 +39,25 @@ Sub-commands:
3839
- `dsp-meta verify [file]`
3940
- [file]: provide the path to the `.toml` file
4041
- `dsp-meta convert`
41-
42-
43-
44-
42+
```
4543

4644
## HCL (HashiCorp Configuration Language) General Syntax
45+
4746
The Metadata Domain Specific Configuration syntax is based on the HCL (HashiCorp Configuration Language) syntax,
4847
with a number of predefined domain specific named blocks. The following is a short introduction to the general syntax.
4948

50-
5149
### Comments
50+
5251
Comments in HCL begin with the "#" symbol and can be placed on their own line or at the end of a line. They are used to
5352
provide explanations or add context to the configuration.
54-
53+
5554
```hcl
5655
# This is a comment in HCL
5756
key = "value" # This is another comment
5857
```
5958

6059
### Blocks
60+
6161
HCL organizes configuration into blocks. Each block starts with the block type followed by a set of braces ({}) that
6262
enclose the block's contents. Blocks can be nested to represent hierarchical structures.
6363

@@ -71,6 +71,7 @@ block_type {
7171
```
7272

7373
### Multiple Blocks
74+
7475
HCL allows you to define multiple blocks of the same type within a configuration. Each block instance is separated by a newline.
7576

7677
```hcl
@@ -84,6 +85,7 @@ block_type {
8485
```
8586

8687
### Block Labels
88+
8789
A block has a type (`resource` in this example). Each block type defines how many labels must follow the type keyword.
8890
The resource block type expects two labels, which are `aws_instance` and `example` in the example below. A particular
8991
block type may have any number of required labels, or it may require none as with the nested network_interface block
@@ -100,7 +102,8 @@ resource "aws_instance" "example" {
100102
```
101103

102104
### Attributes
103-
Inside a block, you define attributes using the key-value syntax. The key and value are separated by an equal sign (=).
105+
106+
Inside a block, you define attributes using the key-value syntax. The key and value are separated by an equal sign (`=`).
104107
Attributes define the properties or settings associated with the block.
105108

106109
```hcl
@@ -110,8 +113,9 @@ block_type {
110113
```
111114

112115
### Strings
116+
113117
HCL supports string values, which are enclosed in double quotes ("). Strings can contain alphanumeric characters,
114-
symbols, and spaces. To include a double quote within a string, you can escape it with a backslash (\).
118+
symbols, and spaces. To include a double quote within a string, you can escape it with a backslash (`\`).
115119

116120
```hcl
117121
message = "Hello, World!"
@@ -120,6 +124,7 @@ escaped_string = "This string contains \"quotes\"."
120124
```
121125

122126
### Numbers
127+
123128
HCL supports both integers and floating-point numbers. Numeric values are written without quotes.
124129

125130
```hcl
@@ -128,6 +133,7 @@ pi = 3.14159
128133
```
129134

130135
### Booleans
136+
131137
Boolean values are represented as either "true" or "false". They are not enclosed in quotes.
132138

133139
```hcl
@@ -136,6 +142,7 @@ debug = false
136142
```
137143

138144
### Lists
145+
139146
HCL supports lists, which are represented by square brackets ([]). Elements in a list are separated by commas. Lists
140147
can contain values of different types.
141148

@@ -145,6 +152,7 @@ numbers = [1, 2, 3, 4, 5]
145152
```
146153

147154
### Heredoc Syntax
155+
148156
HCL supports heredoc syntax for multiline strings. It is enclosed in triple double quotes ("""). Heredocs preserve
149157
leading indentation and line breaks.
150158

@@ -154,15 +162,16 @@ This is a multiline string.
154162
It can span multiple lines.
155163
"""
156164
```
165+
157166
## Metadata HCL: Domain Specific Configuration Language for DSP Metadata
158167

159168
### Style Conventions
169+
160170
- All block types are lowercase
161171
- Indent two spaces for each level of nesting
162172
- When multiple arguments with single-line values appear on consecutive lines, align their equals signs (=)
163173
- When both arguments and blocks appear together inside a block body, place all of the arguments together at the top
164-
and then place nested blocks below them. Use one blank line to separate the arguments from the blocks.
165-
174+
and then place nested blocks below them. Use one blank line to separate the arguments from the blocks.
166175

167176
### Project
168177

@@ -218,7 +227,7 @@ project {
218227
description = "Bern"
219228
url = "https://www.geonames.org/2661552"
220229
}
221-
230+
222231
temporal_coverage periodo {
223232
ref_id = "https://n2t.net/ark:/99152/p06c6g3pvr5"
224233
description = "Under Mediation act, 1803-1814"
@@ -249,7 +258,6 @@ dataset {
249258
}
250259
```
251260

252-
253261
### Person
254262

255263
```hcl

0 commit comments

Comments
 (0)