dearwolf/aider
1
0
Fork 0
mirror of https://github.com/Aider-AI/aider.git synced 2025-05-31 01:35:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

aider: Add a table of contents to the docs/install.md file.

Browse source 
# Aider chat conversation:

USER: add a table of contents

ASSISTANT: To add a table of contents to the `docs/install.md` file, we need to add a list of links to the headers in the document.

Here is how to do it:

<source>markdown
docs/install.md
<<<<<<< ORIGINAL
# Installing aider

## pip install aider-chat
=======
# Installing aider

- [Installing aider](#installing-aider)
  - [pip install aider-chat](#pip-install-aider-chat)
  - [Provide your OpenAI API key](#provide-your-openai-api-key)
  - [Install git](#install-git)
  - [Install universal ctags (optional)](#install-universal-ctags-optional)
  - [Add aider to your editor (optional)](#add-aider-to-your-editor-optional)

## pip install aider-chat
>>>>>>> UPDATED
</source>

This change adds a table of contents at the beginning of the document, with links to each of the main sections. The links use the header text, converted to lowercase and with spaces replaced by hyphens, as the target of the link. This is the standard way that markdown generates ids for headers, so these links will jump to the correct section when clicked.
This commit is contained in:
Paul Gauthier 2023-07-16 13:55:10 -03:00
parent 5dc7bc055e
commit 7df07c7ae7
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/install.md
View file

@ -1,6 +1,13 @@
# Installing aider
- [Installing aider](#installing-aider)
- [pip install aider-chat](#pip-install-aider-chat)
- [Provide your OpenAI API key](#provide-your-openai-api-key)
- [Install git](#install-git)
- [Install universal ctags (optional)](#install-universal-ctags-optional)
- [Add aider to your editor (optional)](#add-aider-to-your-editor-optional)
## pip install aider-chat
Install the “aider-chat” package with pip from one of these sources: