Skip to content

Commit

Permalink
minor: Using full URLs for PyPi README.md compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
AlphaJack committed Feb 23, 2024
1 parent 9a5c93a commit 4af447e
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@
<b>Generate a table of contents from the comments of a file</b>
</p>

![Example table of contents generated by toc](images/showcase.webp)
<!-- PyPi fix-->
<!--![Example table of contents generated by toc](images/showcase.webp)-->

![Example table of contents generated by toc](https://github.com/AlphaJack/toc/raw/master/images/showcase.webp)

## What is it?

Expand All @@ -44,11 +47,11 @@ Second, you run `toc` on that file to turn those comments into a table of conten

Comments are structured in this way:

![Syntax of comments used to generate table of contents](images/syntax.webp)
![Syntax of comments used to generate table of contents](https://github.com/AlphaJack/toc/raw/master/images/syntax.webp)

By running `toc file.c`, you will read the table of contents of that file

![Toc generated from syntax comments](images/simple.webp)
![Toc generated from syntax comments](https://github.com/AlphaJack/toc/raw/master/images/simple.webp)

This table of contents of that file can also be embedded in the original file with `toc -f file.c`

Expand All @@ -66,15 +69,17 @@ If you are using Arch or Manjaro Linux, you can install [toc](https://aur.archli

You should now be able to run `toc -h` to display a list of parameter you can use.

See [USAGE.md](./USAGE.md) for step-by-step explanations of different features, and a list of languages supported natively (e.g. Markdown, AsciiDoc, reStructuredText) or that need special attention (e.g. CSS)
<!--[USAGE.md](./USAGE.md)-->

See [USAGE.md](https://github.com/AlphaJack/toc/blob/master/USAGE.md) for step-by-step explanations of different features, and a list of languages supported natively (e.g. Markdown, AsciiDoc, reStructuredText) or that need special attention (e.g. CSS)

See <https://regex101.com/r/ngzZXN/1> for examples of valid and invalid comments.

## How can I contribute?

See [CONTRIBUTING.md](./CONTRIBUTING.md)
See [CONTRIBUTING.md](https://github.com/AlphaJack/toc/blob/master/CONTRIBUTING.md)

## What has changed from previous versions?

See [CHANGELOG.md](./CHANGELOG.md)
See [CHANGELOG.md](https://github.com/AlphaJack/toc/blob/master/CHANGELOG.md)

0 comments on commit 4af447e

Please sign in to comment.