Work on glossary.md

[edgo914]

ipfs-inactive/docs#56

[johnnymatthews]

Looks good to me! Nice work!

[cwaring]

I had to revert this PR as there are errors that need to be corrected.

All pages need to retain the front-matter data appropriate for the page, a minimum of title and we shouldn't use HTML to reference anchor links. Please change all HTML tags to use valid markdown. e.g.

[[toc]]

## A
### Announcing

## B
### Bitswap

## C
### CBOR

etc

[[toc]] will auto generate a table of contents that will stay in sync as the content changes, see - https://v1.vuepress.vuejs.org/guide/markdown.html#table-of-contents

[edgo914]

@chris Is there an example of [[toc]] somewhere already in ipfs docs? I'm not finding how to do this with the links provided. I'm a coder, sorry @johnny "any one entity" meant "any single entity, like a government or terrorist group" ... not "anyone entity"

…

On Fri, Jan 17, 2020 at 9:13 AM Chris Waring ***@***.***> wrote: I had to revert this PR as there are errors that need to be corrected. All pages need to retain the front-matter data appropriate for the page, a minimum of title and we shouldn't use HTML to reference anchor links. Please change all HTML tags to use valid markdown <https://daringfireball.net/projects/markdown/syntax>. e.g. [[toc]] ## A### Announcing ## B### Bitswap ## C### CBOR etc [[toc]] will auto generate a table of contents that will stay in sync as the content changes, see - https://v1.vuepress.vuejs.org/guide/markdown.html#table-of-contents — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#68>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACA7SXPJIL2XECSY46YVLK3Q6HKMJANCNFSM4KHYU4QA> .

[johnnymatthews]

Is there an example of [[toc]] somewhere already in ipfs docs?

@edgo914 adding a Table of Contents is as simple as adding [[toc]] into your markdown.

The above example creates the ToC as seen below.

---

"any one entity" meant "any single entity, like a government or
terrorist group" ... not "anyone entity"

My bad, don't know how I missed that one. Ignore my edit then :)

[cwaring]

One thing to note is this is only a suggestion if you wish to embed the table of contents in the page itself. With the correct header levels, eg. ## for H2 and ### for H3 the sidebar will be auto populated with the section navigation. In order to disable that you would have to set sidebarDepth: 0 in the header front matter.

I would suggest to use the automatic sidebar navigation over embedding an addition in page ToC unless the sidebar doesn't achieve the desired results. @johnnymatthews it may be best for you to experiment and advise further here.

[edgo914]

How about having the automatic sidebar navigation along with alphabet bar at top of page? Personally, for a glossary, I like an alphabet bar and not a ToC.

…

On Fri, Jan 17, 2020 at 12:47 PM Chris Waring ***@***.***> wrote: One thing to note is this is only a suggestion if you wish to embed the table of contents in the page itself. With the correct header levels, eg. ## for H2 and ### for H3 the sidebar will be auto populated with the section navigation. In order to disable that you would have to set sidebarDepth: 0 in the header front matter. I would suggest to use the automatic sidebar navigation over embedding an addition in page ToC unless the sidebar doesn't achieve the desired results. @johnnymatthews <https://github.com/johnnymatthews> it may be best for you to experiment and advise further here. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#68>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACA7SXOBBOHB42ALGGZTJGTQ6IDMDANCNFSM4KHYU4QA> .

[edgo914]

Sent PR

…

On Fri, Jan 17, 2020, 14:14 Ed Goulet ***@***.***> wrote: How about having the automatic sidebar navigation along with alphabet bar at top of page? Personally, for a glossary, I like an alphabet bar and not a ToC. On Fri, Jan 17, 2020 at 12:47 PM Chris Waring ***@***.***> wrote: > One thing to note is this is only a suggestion if you wish to embed the > table of contents in the page itself. With the correct header levels, eg. > ## for H2 and ### for H3 the sidebar will be auto populated with the > section navigation. In order to disable that you would have to set sidebarDepth: > 0 in the header front matter. > > I would suggest to use the automatic sidebar navigation over embedding an > addition in page ToC unless the sidebar doesn't achieve the desired > results. @johnnymatthews <https://github.com/johnnymatthews> it may be > best for you to experiment and advise further here. > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#68>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/ACA7SXOBBOHB42ALGGZTJGTQ6IDMDANCNFSM4KHYU4QA> > . >

[johnnymatthews]

I like it. Things look much cleaner, and the markdown is easier to read. This type of Table of Contents should only be used for this page though. The glossary is a special page that needs this kind of presentation.

I'll merge the PR once the CI build issue is sorted.