Skip to content

Commit c503f25

Browse files
committed
Revert all auto-formatting changes and commit only the clarification on badge snippets
1 parent 1095df2 commit c503f25

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,23 @@
2222

2323
## Table of Contents
2424

25-
- [Getting Started](#getting-started)
26-
- [Contributing](#contributing)
27-
- [Types of contributions](#types-of-contributions)
28-
- [Licensing](#license)
29-
- [Acknowledgements](#acknowledgements)
30-
- [Legacy GitBook](#legacy-gitbook-deprecated)
25+
- [Getting Started](#getting-started)
26+
- [Contributing](#contributing)
27+
- [Types of contributions](#types-of-contributions)
28+
- [Licensing](#license)
29+
- [Acknowledgements](#acknowledgements)
30+
- [Legacy GitBook](#legacy-gitbook-deprecated)
3131

3232
## Getting Started
3333

3434
To run a local version of this project, please follow these simple steps.
3535

3636
### Prerequisites
3737

38-
- Node.js (Version: >=20.6)
39-
- Use nvm for easy Node management
40-
- Bun (Version: >=1.2.1)
41-
- We use a text-based lockfile which isn't supported below 1.2.1
38+
- Node.js (Version: >=20.6)
39+
- Use nvm for easy Node management
40+
- Bun (Version: >=1.2.1)
41+
- We use a text-based lockfile which isn't supported below 1.2.1
4242

4343
### Set up
4444

@@ -49,6 +49,7 @@ git clone https://github.com/gitbookIO/gitbook.git
4949
```
5050

5151
2. Ensure you are using the project's version of `node`. Running `nvm use` will change your local version to the correct one.
52+
5253
3. Install the project's dependencies through Bun.
5354

5455
```
@@ -71,15 +72,15 @@ bun dev:v2
7172

7273
examples:
7374

74-
- http://localhost:3000/url/gitbook.com/docs
75-
- http://localhost:3000/url/open-source.gitbook.io/midjourney
75+
- http://localhost:3000/url/gitbook.com/docs
76+
- http://localhost:3000/url/open-source.gitbook.io/midjourney
7677

7778
Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser.
7879

7980
### Other development commands
8081

81-
- `bun format`: format the code
82-
- `bun lint`: lint the code
82+
- `bun format`: format the code
83+
- `bun lint`: lint the code
8384

8485
### CI and testing
8586

@@ -123,13 +124,13 @@ Encounter a bug or find an issue you'd like to fix? Helping us fix issues relate
123124

124125
## Deployment
125126

126-
> [!WARNING]
127+
> [!WARNING]
127128
> While it is possible to self-host this project, we do not recommend this unless you are certain this option fits your need.
128-
>
129+
>
129130
> _Looking to add a specific feature in GitBook? Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to get started._
130-
>
131+
>
131132
> Self-hosting this project puts the responsibility of maintaining and merging future updates on **you**. We cannot guarantee support, maintenance, or updates to forked and self-hosted instances of this project.
132-
>
133+
>
133134
> We want to make it as easy as possible for our community to collaborate and push the future of GitBook, which is why we encourage you to contribute to our product directly instead of creating your own version.
134135
135136
This project allows you to self-host the rendering portion of your GitBook published content. Self-hosting has pros and cons.
@@ -174,10 +175,10 @@ HTML example:
174175

175176
GitBook wouldn't be possible without these projects:
176177

177-
- [Next.js](https://nextjs.org/)
178-
- [Bun](https://bun.sh/)
179-
- [Tailwind CSS](https://tailwindcss.com/)
180-
- [Framer Motion](https://www.npmjs.com/package/framer-motion)
178+
- [Next.js](https://nextjs.org/)
179+
- [Bun](https://bun.sh/)
180+
- [Tailwind CSS](https://tailwindcss.com/)
181+
- [Framer Motion](https://www.npmjs.com/package/framer-motion)
181182

182183
## Contributors
183184

@@ -188,4 +189,3 @@ GitBook wouldn't be possible without these projects:
188189
## Legacy GitBook (Deprecated)
189190

190191
Our previous version of GitBook and it's CLI tool are now deprecated. You can still view the old repository and it's commits on this [branch](https://github.com/GitbookIO/gitbook/tree/legacy).
191-

0 commit comments

Comments
 (0)