search

com-lihaoyi / os-lib

OS-Lib is a simple, flexible, high-performance Scala interface to common OS filesystem and subprocess APIs
Other
690 stars 71 forks source link

Links in toc in README don't work #220

Closed szymon-rd closed 1 year ago

szymon-rd commented 1 year ago

Addresses in ToC at the beginning of README do not correspond to the sections in the document. For example, os.read in toc points to os-read section, but the actual name of the section is osread.

lefou commented 1 year ago

Could be that something has changed in Github. We need to investigate and play with AsciiDoc rendering and attributes, I guess.

sake92 commented 1 year ago

GitHub now shows a menu on the top left, when you start scrolling.
So this manually written TOC is a bit redundant IMHO.

lefou commented 1 year ago

This TOC is not manually written! It's automatically generated while rendering the AsciiDoc. It's one of the features of AsciiDoc, that makes it so perfect for GitHub Readmes. I think GitHub somehow broke it's AsciiDoc rendering.