Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc entries disappearing in the luma.gl site #268

Open
tsherif opened this issue Dec 6, 2019 · 1 comment
Open

Doc entries disappearing in the luma.gl site #268

tsherif opened this issue Dec 6, 2019 · 1 comment
Assignees
Labels

Comments

@tsherif
Copy link
Contributor

tsherif commented Dec 6, 2019

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:

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

@ibgreen
Copy link
Collaborator

ibgreen commented Dec 9, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants