googletest icon indicating copy to clipboard operation
googletest copied to clipboard

Markdown documentation table of contents

Open bricoletc opened this issue 5 years ago • 6 comments

Hi,

First off thank you for this fantastic project.

I often find myself going through the gtest or gmock markdowns and wishing there was a TOC at the beginning.

Is there any reason this is not the case?

I could PR some in if not?

bricoletc avatar Feb 05 '20 18:02 bricoletc

Google maintainers always welcome a PR for consideration :)

kuzkry avatar Mar 07 '20 17:03 kuzkry

As said in #2761 , the fact that our internal documentation viewer supports TOC automatically while github doesn't creates friction in simply adding TOC to the markdown. We will need to figure out a maintainable approach to generate TOC ONLY for github doc pages. I will discuss with my team and see if we can come up with a solution, and this seems to be something we need to do from internal (since it's the source of truth).

zhangxy988 avatar Apr 23 '20 18:04 zhangxy988

Sad to hear my solution didn't make it through internal code review, but looking forward to having those TOCs somehow- would make the docs much more useable!

Is your internal doc viewer open source/available?

bricoletc avatar Apr 24 '20 13:04 bricoletc

Are there any news? A wall of text without a basic Table of Contents... it's scary!

H-G-Hristov avatar Oct 11 '21 09:10 H-G-Hristov

I think https://google.github.io/googletest/ is the solution?

bricoletc avatar Oct 11 '21 11:10 bricoletc

@bricoletc not sure. I still need to scroll pages like https://google.github.io/googletest/gmock_for_dummies.html Any updates?

amordo avatar May 08 '23 12:05 amordo