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

added support for removing ToC from specific file #917

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
4 participants
@anantshri

anantshri commented Apr 29, 2016

This theme update will allow user to define a variable no_toc to disable ToC from that specific page.

This should be useful for scenario's like #700 or #900

added support for removing ToC from specific file
This theme update will allow user to define a variable ```no_toc``` to disable ToC from that specific page.

@anantshri anantshri referenced this pull request Apr 29, 2016

Closed

per page customization #900

@waylan

This comment has been minimized.

Show comment
Hide comment
@waylan

waylan Apr 29, 2016

Member

My suggestion would be to reject this in favor of #607, i.e., improvements should be made to the theme so that a user could override a specific portion of the template to match their desired output/behavior.

Member

waylan commented Apr 29, 2016

My suggestion would be to reject this in favor of #607, i.e., improvements should be made to the theme so that a user could override a specific portion of the template to match their desired output/behavior.

@anantshri

This comment has been minimized.

Show comment
Hide comment
@anantshri

anantshri Apr 29, 2016

@waylan I would have also suggested the same if there was anything happening on that specific issue. as there is no work on that specific issue and i needed and found couple of other folks asking for this
specific feature hence i added it to the default theme so that

  1. its available in default theme
  2. People have a clear idea how to implement it in case they want it in custom themes.

anantshri commented Apr 29, 2016

@waylan I would have also suggested the same if there was anything happening on that specific issue. as there is no work on that specific issue and i needed and found couple of other folks asking for this
specific feature hence i added it to the default theme so that

  1. its available in default theme
  2. People have a clear idea how to implement it in case they want it in custom themes.
@waylan

This comment has been minimized.

Show comment
Hide comment
@waylan

waylan Apr 29, 2016

Member

To me, this feature to too specialized and not something that will be wanted/needed across a larger user base. I'm suggesting that rather than MkDocs offering this very specialized feature, MkDocs should make it easier for a user to implement this behavior (or various other similar behaviors) however they want.

While it is true that work on #607 is not moving very quickly, the reason is that we are working on MkDocs in our spare time. That time is already spread thin. If we add more specialized features that we don't need/use, that is one more maintenance headache that will sap our time and take even more time away from working on the features that are actually useful to the larger user base. Besides, if we accept this specialized feature, then we should also accept all the other specialized feature requests. In the end, that time would be better spent making it possible for users to implement there own specialized behavior.

Member

waylan commented Apr 29, 2016

To me, this feature to too specialized and not something that will be wanted/needed across a larger user base. I'm suggesting that rather than MkDocs offering this very specialized feature, MkDocs should make it easier for a user to implement this behavior (or various other similar behaviors) however they want.

While it is true that work on #607 is not moving very quickly, the reason is that we are working on MkDocs in our spare time. That time is already spread thin. If we add more specialized features that we don't need/use, that is one more maintenance headache that will sap our time and take even more time away from working on the features that are actually useful to the larger user base. Besides, if we accept this specialized feature, then we should also accept all the other specialized feature requests. In the end, that time would be better spent making it possible for users to implement there own specialized behavior.

@d0ugal

This comment has been minimized.

Show comment
Hide comment
@d0ugal

d0ugal Apr 29, 2016

Member

I agree with @waylan. Adding features like this in MkDocs itself isn't sustainable, it means we would need to document them and support them across all themes and encourage all external themes to support them too. Just supporting it in one specific place isn't generally useful.

If you really want to go down this path, you could fork the theme and customise it as you wish.

Member

d0ugal commented Apr 29, 2016

I agree with @waylan. Adding features like this in MkDocs itself isn't sustainable, it means we would need to document them and support them across all themes and encourage all external themes to support them too. Just supporting it in one specific place isn't generally useful.

If you really want to go down this path, you could fork the theme and customise it as you wish.

@d0ugal d0ugal closed this Apr 29, 2016

@anantshri

This comment has been minimized.

Show comment
Hide comment
@anantshri

anantshri Apr 30, 2016

If anyone was following this i have forked the default mkdocs theme https://github.com/anantshri/mkdocs-reloaded and i am working on adding these features which i wanted to add on theme.

anantshri commented Apr 30, 2016

If anyone was following this i have forked the default mkdocs theme https://github.com/anantshri/mkdocs-reloaded and i am working on adding these features which i wanted to add on theme.

@anantshri anantshri deleted the anantshri:patch-1 branch Apr 30, 2016

@Himura2la

This comment has been minimized.

Show comment
Hide comment
@Himura2la

Himura2la Aug 8, 2017

Seems like I still can't remove ToC without touching the theme, right?

Himura2la commented Aug 8, 2017

Seems like I still can't remove ToC without touching the theme, right?

@waylan

This comment has been minimized.

Show comment
Hide comment
@waylan

waylan Aug 8, 2017

Member

@Himura2la that is correct. This will likely be addressed in the next major release, but not before.

Member

waylan commented Aug 8, 2017

@Himura2la that is correct. This will likely be addressed in the next major release, but not before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment