typedoc-plugin-markdown icon indicating copy to clipboard operation
typedoc-plugin-markdown copied to clipboard

feat(docusaurus): disable globals page

Open felipecrs opened this issue 4 years ago • 5 comments
trafficstars

I just realized that my docs would look much fancier if I didn't had the globals page at all:

With: image

Without image

So the sidebar itself is my Table of Contents (therefore I don't need the Globals page).

So an option to disable it would be welcome. :-)

felipecrs avatar Mar 05 '21 17:03 felipecrs

We could use a similar sidebar option here to your suggestion for #203 omitTOC. It will still generate the page but it won't do any harm.

tgreyuk avatar Mar 05 '21 17:03 tgreyuk

Hm... we could still access the Globals page by typing in the URL though, so it's not exactly the same thing.

felipecrs avatar Mar 05 '21 17:03 felipecrs

You could - but if thats an issue then it can be a global option.

tgreyuk avatar Mar 05 '21 17:03 tgreyuk

It's not really an big issue... but if it was up to me I would prefer to prevent it :-).

felipecrs avatar Mar 05 '21 18:03 felipecrs

@felipecrs still pondering over this one. On the face of it the page serves no purpose, but it may contain inline symbols in some cases and also without it there is no entry point / slug to the api. Category linking will help if it gets implemented https://github.com/facebook/docusaurus/issues/2643 as the 'API' category can have it own page thus clean up the sidebar.

tgreyuk avatar May 06 '21 21:05 tgreyuk