Skip to content

Commit

Permalink
Markdownlint fixes (Chainlit#1348)
Browse files Browse the repository at this point in the history
  • Loading branch information
EWouters authored Sep 17, 2024
1 parent bfc6ae9 commit 41cf43d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To contribute to Chainlit, you first need to setup the project on your local mac

<!--
Generated using https://ecotrust-canada.github.io/markdown-toc/.
I've copy/pasted the whole document there, without the previous two headings.
I've copy/pasted the whole document there, and then formatted it with prettier.
-->

- [Contribute to Chainlit](#contribute-to-chainlit)
Expand Down Expand Up @@ -37,11 +37,11 @@ I've copy/pasted the whole document there, without the previous two headings.

With this setup you can easily code in your fork and fetch updates from the main repository.

1. Go to https://github.com/Chainlit/chainlit/fork to fork the chainlit code into your own repository.
1. Go to [https://github.com/Chainlit/chainlit/fork](https://github.com/Chainlit/chainlit/fork) to fork the chainlit code into your own repository.
2. Clone your fork locally

```sh
$ git clone https://github.com/YOUR_USERNAME/YOUR_FORK.git
git clone https://github.com/YOUR_USERNAME/YOUR_FORK.git
```

3. Go into your fork and list the current configured remote repository.
Expand All @@ -55,7 +55,7 @@ $ git remote -v
4. Specify the new remote upstream repository that will be synced with the fork.

```sh
$ git remote add upstream https://github.com/Chainlit/chainlit.git
git remote add upstream https://github.com/Chainlit/chainlit.git
```

5. Verify the new upstream repository you've specified for your fork.
Expand Down Expand Up @@ -103,7 +103,7 @@ If you've made it this far, you can now replace `chainlit/hello.py` by your own

## Start the UI from source

First, you will have to start the server either [from source](#start-the-chainlit-server-from-source) or with `chainlit run... `. Since we are starting the UI from source, you can start the server with the `-h` (headless) option.
First, you will have to start the server either [from source](#start-the-chainlit-server-from-source) or with `chainlit run...`. Since we are starting the UI from source, you can start the server with the `-h` (headless) option.

Then, start the UI.

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ Full documentation is available [here](https://docs.chainlit.io). You can ask Ch
> Check out [Literal AI](https://literalai.com), our product to monitor and evaluate LLM applications! It works with any Python or TypeScript applications and [seamlessly](https://docs.chainlit.io/data-persistence/overview) with Chainlit by adding a `LITERAL_API_KEY` in your project.
<p align="center">
<img src="https://github.com/Chainlit/chainlit/assets/13104895/0c2cc7a9-766c-41d3-aae2-117a2d0eb8ed" width="80%" />
<img src="https://github.com/Chainlit/chainlit/assets/13104895/0c2cc7a9-766c-41d3-aae2-117a2d0eb8ed" alt="Chainlit user interface" width="80%"></img>
</p>

## Installation

Open a terminal and run:

```bash
$ pip install chainlit
$ chainlit hello
```sh
pip install chainlit
chainlit hello
```

If this opens the `hello app` in your browser, you're all set!
Expand Down Expand Up @@ -77,8 +77,8 @@ async def main(message: cl.Message):

Now run it!

```
$ chainlit run demo.py -w
```sh
chainlit run demo.py -w
```

<img src="/images/quick-start.png" alt="Quick Start"></img>
Expand Down

0 comments on commit 41cf43d

Please sign in to comment.