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

Include headers of multiple levels in the guide content index #328

Closed
bryntum opened this issue Feb 15, 2013 · 4 comments
Closed

Include headers of multiple levels in the guide content index #328

bryntum opened this issue Feb 15, 2013 · 4 comments

Comments

@bryntum
Copy link

bryntum commented Feb 15, 2013

Markdown defines the 1st level headers as headers with "===" under them and 2nd level - with "-------" (or with one "#" character in the beginning for 1st level and 2 "##" for 2nd level).

When creating the content index, JSDuck currently recognizes only the 2nd level headers.

Introduction
============
Ext Gantt allows you 

Basic features
==============

Weekends, highliting, skeep during DD

how to make it plain (no holidays at all)

Defining availability for individual days
=========================================

weekday, day override, week day override

parent - child

Availability for tasks
----------------------

Availability for resources
--------------------------

For example, for the text above the following content will be generated:
screen84

Would be great if it will also include 1st level headers in the content.

Thanks, Nickolay

@nene
Copy link
Member

nene commented Feb 15, 2013

Thats intentional, because the first level header is intended as the title of the whole guide. It's supposed to be used only once - at the beginning of the guide.

@nene nene closed this as completed Feb 15, 2013
@bryntum
Copy link
Author

bryntum commented Feb 18, 2013

Hm.. Then perhaps a 3rd level headers could be included in the contents? Right now only 2nd level headers are included in the content, meanwhile its pretty common to have sections and sub-sections in the guides.

@nene
Copy link
Member

nene commented Feb 18, 2013

Yeah, I guess that would be a reasonable thing to do.

Opening this issue back up, although not sure when I get to that...

@nene nene reopened this Feb 18, 2013
scottrobertwhittaker added a commit to scottrobertwhittaker/jsduck that referenced this issue Oct 31, 2013
@nene
Copy link
Member

nene commented Nov 27, 2013

This has been fixed now with the addition of --guide-toc-level option.

@nene nene closed this as completed Nov 27, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant