ocular icon indicating copy to clipboard operation
ocular copied to clipboard

Doc entries disappearing in the luma.gl site

Open tsherif opened this issue 5 years ago • 1 comments

The site is staged here: https://tsherif.github.io/luma.gl/docs

Some entries in the table of contents aren't showing up in the generated sidebar, e.g. the first entry in the API reference section is a submenu "Overview" with README titled "Overview":

Screen Shot 2019-12-06 at 8 46 59 AM

But it doesn't show up in the sidebar: Screen Shot 2019-12-06 at 8 46 46 AM

It is however accessible via direct navigation: https://tsherif.github.io/luma.gl/docs/api-reference

A few other entries that aren't listed:

  • https://tsherif.github.io/luma.gl/docs/get-started
  • https://tsherif.github.io/luma.gl/docs/contributor-guide

It seems to be only files named README.md, but changing the names didn't help.

tsherif avatar Dec 06 '19 13:12 tsherif

There are some particularities in ocular's processing of markdown.

  • README.md files are treated as the default entry for that directory. If you delete the /README part it should work.
  • There must be a # <title> markdown stanza on the first line of the file

I did this in the PR I just opened on luma.gl website and it seems to have fixed it.

While easy to fix, there should be better defaults and reasonable warnings for these cases.

ibgreen avatar Dec 09 '19 01:12 ibgreen