Table of Contents for Programming Guides #321

Open
chris838 opened this Issue Feb 25, 2013 · 3 comments

Projects

None yet

3 participants

@chris838

It would be great if we could generate programming guides using markdown template files which have a Table of Contents in the sidebar, just like Apple programming guides. Example: https://developer.apple.com/library/ios/#documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html%23//apple_ref/doc/uid/TP40011210

@tomaz
Owner
tomaz commented Feb 26, 2013

This is somewhat related to #188.

On 25. feb. 2013, at 19:22, chris838 notifications@github.com wrote:

It would be great if we could generate programming guides using markdown template files which have a Table of Contents in the sidebar, just like Apple programming guides. Example: https://developer.apple.com/library/ios/#documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html%23//apple_ref/doc/uid/TP40011210


Reply to this email directly or view it on GitHub.

@chris838

I've made a start by editing document-template.html. I can generate guides with all the required HTML structure, the sidebar and title etc.

Can you give me a pointer as to which files I need to start editing to generate the ToC? And do you have any suggestions as to what markup to use to denote the ToC within the markdown file?

Also - document-template.html now contains references to the index page and hierarchy page. Any suggestions on how to make these work? I have fixed them manually for now but this will break if the guides are stored in subdirectories.

@mralexgray

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment