search

Dasix / grits-plugin-docs

A Grits plugin for generating documentation
Other
1 stars 1 forks source link

TOC generation fails for deeply nested content #40

Open vmadman opened 8 years ago

vmadman commented 8 years ago

The actual problem was with content folders that started with numbers, e.g. content/projects/something/2x. This bug has been fixed and should work properly now.

@robwhite4 : this bug was hugely impactful and was affecting some of our live deployments in pretty severe ways. I'd appreciate your help in verifying that this bug is, indeed, fixed.

I am going to close this issue anyway, until we find reason to reopen it.

robwhite4 commented 8 years ago

@vmadman ,

Ok, so I don't know why, but there is still some issue with this. I created a file that started with a number and it broke my TOC. Once I renamed the file, the TOC started working again. The weird thing is the file should not have affected the TOC anyway as it was not included as part of any 'section'. But, for some reason, it did.

First file structure that worked:

content/
    |-- cap-dev/
    |    |-- index.md (section: ARWA Capacity Development order: 200)
    |-- full-reports/
    |    |-- (stuff here that was always fine. No files start with numbers.)
    |    |-- index.md (section: ARWA Capacity Development order: 300)
    |-- index.md (section: ARWA Capacity Development order: 1)

How I broke it:

content/
    |-- cap-dev/
    |    |-- historical/
    |    |    |-- 2015-2016-contract.md (<-- that broke my TOC.  No section or order declared in white-matter)
    |    |-- index.md (section: ARWA Capacity Development order: 200)
    |-- full-reports/
    |    |-- (stuff here that was always fine. No files start with numbers.)
    |    |-- index.md (section: ARWA Capacity Development order: 300)
    |-- index.md (section: ARWA Capacity Development order: 1)

How I fixed it:

content/
    |-- cap-dev/
    |    |-- historical/
    |    |    |-- cap-dev-2015-2016-contract.md (<-- renamed.  No section or order declared in white-matter)
    |    |-- index.md (section: ARWA Capacity Development order: 200)
    |-- full-reports/
    |    |-- (stuff here that was always fine. No files start with numbers.)
    |    |-- index.md (section: ARWA Capacity Development order: 300)
    |-- index.md (section: ARWA Capacity Development order: 1)

So, I'm going to re-open this issue. If I can figure out how. ;)

Thanks,

Rob

robwhite4 commented 8 years ago

I guess you might have been saying what I pointed out from the beginning, but your comment specifies folders and not files. So, just for clarity. I broke it with a file.

Thanks,

Rob