OK, I saw your other email about more ToC changes coming. I think I am going to try to generate the ToC.
-Alex On 1/25/18, 6:32 PM, "Alex Harui" <[email protected]> wrote: >On 1/25/18, 4:11 PM, "Andrew Wetmore" <[email protected]> wrote: > >>Hi: >> >>I have not been touching the ToC file because it looks very easy to get >>wrong. > >Yeah, I was fiddling with the ToC and thinking the same thing. I'm >wondering how many more changes to the ToC we'll be doing. If it is just >a few more to implement your proposed ToC, we could just keep the current >way and fix the small things as we find it. If we think we're going to be >adding new entries and/or renaming entries, maybe it is worth it for me to >try to spend a day making the ToC "generate" from the .MD files. We would >probably dictate the organization of the ToC in a JSON file, but the >entries would be less error prone. Maybe like: > >{ "toc": [ "index.md" : [ "welcome/high-level-view.md" : [] , > "welcome/features-and-concepts.md": [ >"welcome/features/as3.md" ... > "get-started.md" : ["get-started/system-requirements.md" ... > >Essentially, a hierarchical object that just lists the file names in the >order you want them to appear in the ToC. I think I can get Jekyll to >generate the ToC by using the page titles. > > > >>I have also not been inserting links from one .md page to another >>because I am not clear whether we are using relative or absolute links >>(not >>sure, for instance, whether there is a performance benefit of one over >>the >>other...). > >In the .md files, links have to be a full path without the leading slash. >So to link to /welcome/features/as3.md, you would use > > [as3](welcome/features/as3.html) > >> >>Also, when we link out from the help docs to another section of the >>Royale >>site, or any other resource, we should pop a new browser window, not take >>the reader away from the help docs. Is there a standard way to declare >>that >>when writing a link in markdown? Is it the same as in HTML >>("target=_blank")? > >I had to look it up. The syntax is: > >>[as3](welcome/features/as3.html){:target='_blank'} > >I just modified index.md and tested it and it seemed to work. > >-Alex >
