lukastaegert
commented
3 years ago Just looking at the updated website, I think it is a really good idea, especially the big-list-of-options profits a lot from this. Alternatively, we could also put the list into the side-bar, but I was always wondering if this wouldn't make the side bar unusable. One might wonder if we want to work a little on the styling e.g. by refining the CSS for nested lists, but on first glance this looks ok-ish to me.
There is a tiny glitch after "JavaScript API" that I want to check out. Is unrelated and can be fixed in the markdown.
kleinfreund
Small disclaimer: Please read this pull request as a proposition. I don’t know if you even want to have this on your website. If not in this form, I hope another way can be found to improve the site’s navigability. Also, I have never worked with Svelte before so please let me know if any changes to the PR in its current form are required.
Changes
Adds a generated, two-level deep table of contents to all subsections (i.e. to the documents found in the
guide/[lang]/directories). The elements in the table of contents are plain links pointing to fragment identifiers of their corresponding heading elements (i.e. the heading elements’ ID attributes). This is intended to improve the navigability of the documentation especially for sections like “Plugin Development” and “Big list of options” which both have many, many sub sections.Moves the chain of
String.prototype.replacecalls sanitizing heading markup into its own function because it’s now also needed for the logic preparing the new table of content data. Also adds two new calls replacing the HTML entities<and>which appear in some of the headings (e.g. https://rollupjs.org/guide/en/#-p-plugin---plugin-plugin).Motivation
Pretty regularly when working with Rollup, I get a bit frustrated when looking up the documentation for a certain feature or configuration option because the website is one big document that has no built-in search beyond what a browser offers. I tend to resort to searching the page using full-text search (e.g. via Ctrl+F) which becomes tedious quickly when trying to look up options one finds in example configurations, etc.
Being able to click on the “Big list of options” entry in the main table of contents in the sidebar and then having a list of all the options linked to their sections is something I wanted many, many times when working with Rollup before so I figured it’s time to (try to) make it happen.
Miscellaneous
npm run lintandnpm teston this branch.