Skip to content

Commit

Permalink
docs: more concise README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nik-rev committed Dec 16, 2024
1 parent 47cd3f6 commit 9b8a906
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,36 @@

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

You can use the [Helix Editor](https://helix-editor.com/) to refactor code efficiently.
Examples of efficiently refactoring text in the [Helix Editor](https://helix-editor.com/).

## Contributing

### Adding new examples

You can add new examples by editing the [`index.mdx`](https://github.com/NikitaRevenco/helix-golf/edit/main/src/content/docs/index.mdx) file.

To add an entry, copy-paste the following template:
To add an entry, copy-paste the following template into the [`index.mdx`](https://github.com/NikitaRevenco/helix-golf/edit/main/src/content/docs/index.mdx) file:

````mdx
#### A descriptive title
#### A concise title

An optional description.

##### Before

```js
```file extension
input file
```

##### After

```
```file extension
output file
```

##### Command

<details>

<summary>
`insert command here`
</summary>
<summary>`insert command here`</summary>

1. Steps taken
1. To perform the
Expand Down

0 comments on commit 9b8a906

Please sign in to comment.