You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Lido Docs
2
2
3
-
Lido documentation is built using [Docusaurus 3](https://docusaurus.io/). The resulting version of documentation hosted via Github Pages from branch`gh-pages` of this repository.
3
+
Lido documentation is built using [Docusaurus 3](https://docusaurus.io/). The resulting version of documentation hosted via GitHub Pages from the`gh-pages`branch of this repository..
4
4
5
5
## Installation
6
6
@@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo
18
18
19
19
## Documentation Pages
20
20
21
-
Documentation pages stored in `/docs` folder. By default files with `.md` and `.mdx` extensions are treated as documentation pages. Every document has a unique `id`. By default, a document `id` is the name of the document (without the extension) relative to the root docs directory.
21
+
Documentation pages are stored in the`/docs` folder. By default files with `.md` and `.mdx` extensions are treated as documentation pages. Every document has a unique `id`. By default, a document `id` is the name of the document (without the extension) relative to the root docs directory.
22
22
23
23
For example, `greeting.md` id is `greeting` and `guide/hello.md` id is `guide/hello`.
24
24
@@ -53,13 +53,13 @@ More information about document metadata fields available [there](https://docusa
53
53
54
54
### Documentation Sidebar
55
55
56
-
The appearance of sidebar controlled manually via `sidebars.js` file. This file is used to:
56
+
The appearance of the sidebar is controlled manually via the`sidebars.js` file. This file is used to:
57
57
58
58
- Group multiple related documents
59
59
- Display a sidebar on each of those documents
60
60
- Provide a paginated navigation, with next/previous button
61
61
62
-
By default new added pages don't added to sidebar automatically. For example to add new page `faq.md` as the last item of sidebar we need modify `sidebar.js`next way:
62
+
By default, newly added pages are not added to the sidebar automatically. For example, to add a new page `faq.md` as the last item of the sidebar, we need to modify `sidebar.js`in the following way:
63
63
64
64
```js
65
65
module.exports= {
@@ -83,9 +83,9 @@ This command generates static content into the `build` directory and can be serv
83
83
84
84
## Deployment
85
85
86
-
Build and deploy happens automatically when pull request is merged to `main`branch or someone pushes to `main` branch directly.
86
+
Build and deployment happen automatically when a pull request is merged to the `main`branch or someone pushes to the`main` branch directly.
87
87
88
-
To build documentation locally and push built version to the `gh-pages` branch use next command:
88
+
To build the documentation locally and push the built version to the `gh-pages` branch, use the following command:
89
89
90
90
```console
91
91
GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy
0 commit comments