Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix capitalization error #6769

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Fix capitalization error #6769

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/reference/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
The docs are written in [AsciiDoc](https://asciidoc.org/)(`.adoc`). You can view the docs locally in many ways.

- View on IDE
- View in Html
- View in HTML
- View in PDF

## View on IDE

- Install `AsciiDoc`plugins in `VsCode` or `Intellij IDEA`

## View in Html
## View in HTML
### Install `asciidoctor`

- Mac OS
Expand All @@ -21,7 +21,7 @@ brew install asciidoctor
apt-get install asciidoctor
```

### Convert to Html
### Convert to HTML
> Tips:`pwd` is `cairo/docs/reference`

- Convert a single file
Expand All @@ -34,7 +34,7 @@ asciidoctor src/Summary.adoc
asciidoctor src/*.adoc
```

Now `Html` versions of the documentation will be generated.
Now `HTML` versions of the documentation will be generated.

## View in PDF
### Install `asciidoctor`
Expand Down