Skip to content

Commit ef25cca

Browse files
authored
Update README.md (#1159)
Update of the text
1 parent 2a2e306 commit ef25cca

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
Blog Eleven Labs
22
===================
33

4-
Welcome to the [ElevenLabs] blog (https://blog.eleven-labs.com), this is [Jamstack](https://jamstack.org/) website.
4+
Welcome to the [ElevenLabs] blog (https://blog.eleven-labs.com), this is a [Jamstack](https://jamstack.org/) website.
55

66
----------
77

88
What's inside?
99
-------------
1010

11-
This website is 100% [TypeScript](https://www.typescriptlang.org/) with [Jamstack](https://jamstack.org/) architecture.
11+
This website is 100% [TypeScript](https://www.typescriptlang.org/) with a [Jamstack](https://jamstack.org/) architecture.
1212

1313
It was developed based on the boilerplate [React SSR with Vite and Prerender](https://github.com/eleven-labs/typescript-boilerplates).
1414

1515
It uses Eleven Labs [Design System](https://github.com/eleven-labs/design-system).
1616

1717
----------
1818

19-
Installation the blog
19+
Setting up the blog
2020
-------------
2121

22-
**Technical requirements to work on this project**
22+
**Technical requirements**
2323
- [TypeScript](https://www.typescriptlang.org/)
2424
- [React](https://reactjs.org/)
2525
- [React Router](https://reactrouter.com/en/main)
2626
- [Vite](https://vitejs.dev/)
2727
- [Storybook](https://storybook.js.org/)
2828

29-
**Computer requirements to work on this project**
29+
**Computer requirements**
3030

3131
- [git](https://git-scm.com/download/linux)
3232

@@ -111,14 +111,14 @@ Create your article page
111111

112112
**1 - Create the markdown file**
113113

114-
In the folder `_articles` add a markdown file with the name of your article and prefixed with the date.
114+
In the folder `_articles` add a markdown file with the name of your article prefixed with the date.
115115
```bash
116116
cd _articles && touch YYYY-MM-DD-slug.md
117117
```
118118

119119
**2 - Add content to the file**
120120

121-
Here is the template of the file.
121+
Here is the file's template.
122122

123123
```md
124124
---
@@ -147,7 +147,7 @@ Content of your article in markdown
147147

148148
> If your title or excerpt contains `:`, `"` use the syntax `>` or add your content between quotes (`"`)
149149
150-
> If you want to add a 2 empty lines, you can use `\` syntax: ex:
150+
> If you want to add 2 empty lines, you can use the syntax `\` ex:
151151
```
152152
first paragraph.
153153
@@ -171,8 +171,8 @@ In order to have a quality image, we ask you to integrate an image with a minimu
171171

172172
**4 - Write the content of the article**
173173

174-
The content of the article be written in markdown.
175-
You can use one of the solutions:
174+
The content of the article has to be written in markdown.
175+
You can use one of these markdown editors:
176176
- [StackEdit](https://stackedit.io)
177177
- [Dillinger](http://dillinger.io)
178178

@@ -194,15 +194,15 @@ And to specify a size on the image, you can add the arguments (`width`, `height`
194194
![alt of image]({BASE_URL}/imgs/articles/YYYY-MM-DD-slug/image-name.png?width=500)
195195
```
196196

197-
If you need to add internal anchor links from your article to other article of our blog, use this syntax:
197+
If you need to add internal anchor links from your article to other articles of our blog, use this syntax:
198198
```md
199199
[title of destination article]({BASE_URL}/fr/destination-article-slug)
200200
```
201201

202202
> Warning: Don't add html in your markdown, you don't have to override the blog template in the markdown.
203203
204204
This blog supports admonitions pannels `warning` ; `info` ; `tip` and `note` to generate colored panels.
205-
When using `<div>` attribute `markdown="1"` text block is rendered as Markdown. The first line must be left empty, else the block will be rendered as html
205+
When using `<div>` attribute `markdown="1"` text block is rendered as Markdown. The first line must be left empty, or the block will be rendered as html
206206

207207
```md
208208
<div class="admonition warning" markdown="1"><p class="admonition-title">Your Panel Title</p>
@@ -218,7 +218,7 @@ Create your branch and add your pull request.
218218
git checkout -b feat/add-article-slug
219219
```
220220

221-
Once your article is finished and you want it to be published and add the label `publication` to your pull request.
221+
Once your article is finished and you want it to be published, add the label `publication` to your pull request.
222222

223223
----------
224224

@@ -227,14 +227,14 @@ Create your tutorial page
227227

228228
**1 - Create the markdown file**
229229

230-
In the folder `_tutorials` pick the subfolder `fr` or `en` depending on the translation, then create folder with the name of your tutorial and prefixed with the date (`YYYY-MM-DD-slug`).
230+
In the folder `_tutorials` pick the subfolder `fr` or `en` depending on the translation, then create a folder with the name of your tutorial, prefixed with the date (`YYYY-MM-DD-slug`).
231231
```bash
232232
cd _tutorials && mkdir YYYY-MM-DD-slug
233233
```
234234

235235
**2 - Add content to the file**
236236

237-
Inside the folder named `YYYY-MM-DD-slug` you created, add a file named `index.md` Here is the template of the file.
237+
Inside the folder named `YYYY-MM-DD-slug` you created, add a file named `index.md`. Here is the template of the file.
238238

239239
```md
240240
---
@@ -297,4 +297,4 @@ Create your branch and add your pull request.
297297
git checkout -b feat/add-tutorial-slug
298298
```
299299

300-
Once your tutorial is finished and you want it to be published and add the label `publication` to your pull request.
300+
Once your tutorial is finished and you want it to be published, add the label `publication` to your pull request.

0 commit comments

Comments
 (0)