WIP - Add table of content option and generation #75

scandinave · 2020-06-17T13:58:52Z

PR for #74

scandinave · 2020-06-17T14:01:02Z

You can follow the progression .

Should I provide a default theme for the content table or let the user provide his own?

scandinave · 2020-06-17T17:13:03Z

I just test my implementation with page break. All headings after page break are not take into account. Any idea to fix this?

scandinave · 2020-06-18T07:17:49Z

Ok, this is corrected. Just one test that failed.

test('getHtml should inject rendered markdown', (t) => {
	const html = getHtml('# Foo', defaultConfig).replace(/\n/g, '');

	t.regex(html, /<body class=""><h1 id="foo">Foo<\/h1>.*<\/body>/);
});

I don't understand how this can be validated as getHtml always return string with tag. any idea?

simonhaenisch

Just while you're at it, I'm not really a fan of OOP, so can you change the InitMarked class back to a function instead? It would be nice if the TOC generation function is a separate module and we can load it with marked.use().

Another thing we need to do is check !Object.prototype.hasOwnProperty.call(renderer, 'heading') because we don't want to override a user's custom heading renderer.

Also, I find the current configuration too complicated. It should just check sth like

html.includes('<!-- TOC -->')

and if present, it should automatically be enabled. Then toc_heading and toc_depth can be two new config options (not nested).

Alternatively, we could actually go with <div class="toc"></div> because then we could allow custom content there, like

<div class="toc">

## Table of Contents

</div>

(the blank lines are important for this mix of html and markdown btw)

and then append the TOC. More complicated to do this though (as we can't use document.querySelector, unless we only append the TOC in the browser context).

scandinave · 2020-06-18T12:53:29Z

Ok i will update ma PR soon. The type definition for Marked is out of date and missing use function.

simonhaenisch · 2020-06-18T13:43:31Z

Cool thanks! You can do (marked as any).use(...) for now, and hopefully someone will update @types/marked soon 🤓

scandinave · 2020-06-19T06:55:38Z

I have made a PR on definitlytyped to update the typings.

scandinave · 2020-06-19T08:10:18Z

Ok i have make the change. but there is still the test 'getHtml should inject rendered markdown' that does not pass

readme.md

src/lib/config.ts

src/lib/get-html.ts

src/lib/get-marked-with-highlighter.ts

simonhaenisch · 2020-06-19T15:56:06Z

src/lib/get-marked-with-highlighter.ts

@@ -1,20 +1,18 @@
 import { getLanguage, highlight } from 'highlight.js';
 import marked, { MarkedOptions } from 'marked';

-export const getMarked = (options: MarkedOptions) => {
+export const getHighlightRenderer = (options: MarkedOptions) => {
 const renderer = options.renderer ?? new marked.Renderer();


It doesn't make sense to have this in combination with marked.use() anymore. If there's options.renderer, then we need to call marked.use({ renderer: options.renderer }) instead.

can you explain me a bit more ? i'm not see what modification i need to do.

simonhaenisch · 2020-06-19T15:58:55Z

src/lib/get-marked-with-toc.ts

+export const getHeadingRenderer = (config: Config) => {
+ toc = [];
+ const options = config.marked_options;
+ const renderer = options.renderer ?? new marked.Renderer();


Same thing as previous comment, we don't want to extend the user's custom renderer.

scandinave · 2020-06-22T09:22:22Z

Great news. My PR for the type was accepted . DefinitelyTyped/DefinitelyTyped#45578

simonhaenisch · 2020-06-25T20:34:55Z

Hey @scandinave I've gotten busy with other work and won't be able to have a proper look at this in the next couple weeks. Are you ok to just use your fork in the mean-time? You can npm uninstall -g md-to-pdf and then npm link in your fork, so that it's symlinked into your global registry.

I'll get to it when I have some spare time for this project again.

scandinave · 2020-06-25T20:40:17Z

Ok no problem. Take your time :)

MangelMaxime · 2020-08-31T10:00:42Z

Hello,

I wonder what will happen for people using an extension to manage their TOC.

Like Markdown TOC in VSCode.

<!-- TOC -->

- [Title 1](#title-1)
    - [Title 1.1](#title-11)
- [Title 2](#title-2)
- [Title 2.2](#title-22)

<!-- /TOC -->

# Title 1

## Title 1.1

# Title 2

# Title 2.2

I suppose you are using  presence to trigger the TOC generation and so in this case the output file with have 2 TOC in it.

If that's the case, I think it would be nice to add a new options to control if TOC should be generated or not and use  to know the position where the TOC should be placed in the file.

simonhaenisch · 2020-09-01T11:49:19Z

Could just use --toc-depth=0 to disable it, I guess.

Fix test

scandinave · 2020-09-13T16:41:29Z

--toc-depth=0 will only makes links to not be generated. But the wrapper's title of the TOC will still be generated.

I can just add a check for toc-depth=0 in this condition if (html.includes('') && toc.length !== 0) { to fix this or add another parameter as suggested by @MangelMaxime.

mr-potato-head · 2024-02-19T16:03:01Z

Any news on the TOC feature ?

simonhaenisch reviewed Jun 18, 2020

View reviewed changes

scandinave force-pushed the master branch 2 times, most recently from a9fe4fc to 61cb8fd Compare June 19, 2020 08:04

scandinave requested a review from simonhaenisch June 19, 2020 12:42

simonhaenisch requested changes Jun 19, 2020

View reviewed changes

scandinave requested a review from simonhaenisch June 25, 2020 20:13

scandinave added 5 commits September 13, 2020 18:22

Add table of content option and generation

1811055

Add toc_skip

c993300

Rename ctx generated_toc to parts

af6fa8e

Update @types/marked to 1.1.0

4951fa2

Add style class to headings to allow more customization

786c1e2

Fix test

scandinave force-pushed the master branch from 043e407 to 786c1e2 Compare September 13, 2020 16:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP - Add table of content option and generation #75

WIP - Add table of content option and generation #75

scandinave commented Jun 17, 2020

scandinave commented Jun 17, 2020 •

edited

scandinave commented Jun 17, 2020

scandinave commented Jun 18, 2020

simonhaenisch left a comment

scandinave commented Jun 18, 2020

simonhaenisch commented Jun 18, 2020

scandinave commented Jun 19, 2020

scandinave commented Jun 19, 2020

simonhaenisch Jun 19, 2020

scandinave Jun 22, 2020 •

edited

simonhaenisch Jun 19, 2020

scandinave commented Jun 22, 2020

simonhaenisch commented Jun 25, 2020 •

edited

scandinave commented Jun 25, 2020

MangelMaxime commented Aug 31, 2020

simonhaenisch commented Sep 1, 2020

scandinave commented Sep 13, 2020

mr-potato-head commented Feb 19, 2024

WIP - Add table of content option and generation #75

Are you sure you want to change the base?

WIP - Add table of content option and generation #75

Conversation

scandinave commented Jun 17, 2020

scandinave commented Jun 17, 2020 • edited

scandinave commented Jun 17, 2020

scandinave commented Jun 18, 2020

simonhaenisch left a comment

Choose a reason for hiding this comment

scandinave commented Jun 18, 2020

simonhaenisch commented Jun 18, 2020

scandinave commented Jun 19, 2020

scandinave commented Jun 19, 2020

simonhaenisch Jun 19, 2020

Choose a reason for hiding this comment

scandinave Jun 22, 2020 • edited

Choose a reason for hiding this comment

simonhaenisch Jun 19, 2020

Choose a reason for hiding this comment

scandinave commented Jun 22, 2020

simonhaenisch commented Jun 25, 2020 • edited

scandinave commented Jun 25, 2020

MangelMaxime commented Aug 31, 2020

simonhaenisch commented Sep 1, 2020

scandinave commented Sep 13, 2020

mr-potato-head commented Feb 19, 2024

scandinave commented Jun 17, 2020 •

edited

scandinave Jun 22, 2020 •

edited

simonhaenisch commented Jun 25, 2020 •

edited