Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Question] how to display 'table of content'? #318

Open
hawkoli1987 opened this issue Jan 28, 2023 · 2 comments
Open

[Question] how to display 'table of content'? #318

hawkoli1987 opened this issue Jan 28, 2023 · 2 comments

Comments

@hawkoli1987
Copy link

First of all, a big thank you for the elegant design and user-friendly features. It's especially helpful to person completely new to webpage design like myself!

From the documentation, it seems really easy to create a TOC, just by adding two lines of code in the markdown:

1. this ordered seed list will be replaced by the toc
{:toc}

However, it never gets displayed on my page, while the other features (e.g. notes and quotes) works perfectly.

I have installed the 'jekyll-toc' plugin in gemfile, and added it in '_config.yml' plugin as well, but it still doesn't show up.

Are there any other basic steps that I've missed out?

hawkoli1987

@cbirkenbeul
Copy link

Hi,
did you marked the list items as headlines? You should put a # as h1 or ## as h2. Regular markdown.

@tgaff
Copy link

tgaff commented Sep 4, 2023

I found that this didn't work if you were using the GFM markdown processor. Instead I had to use the theme default kramdown.

# _config.yml
markdown: kramdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants