Support to set whether the sidebar will be shown in each single post.

[tsanie]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines.
• Tests for the changes have been added (for bug fixes / features).
  • Muse | Mist have been tested.
  • Pisces | Gemini have been tested.
• Docs have been added / updated (for bug fixes / features).

PR Type

What kind of change does this PR introduce?

• Bugfix.
• Feature.
• Code style update (formatting, local variables).
• Refactoring (no functional changes, no api changes).
• Build related changes.
• CI related changes.
• Documentation content changes.
• Other... Please describe:

What is the current behavior?

Now we couldn't control the sidebar will be shown in some posts and not be shown in the other ones.

Issue Number(s): #92

What is the new behavior?

If you've written a front-matter sidebar, then the sidebar will be controlled by it.

• Screens with this changes: N/A
• Link to demo site with this changes: https://tsanie.us/about/ (The sidebar will be shown even the page didn't have a TOC)

How to use?

In any post source file source/**/XXX.md:

...
date: 2018-01-28 21:16:00
sidebar: false
---

...

Does this PR introduce a breaking change?

• Yes.
• No.

[ivan-nginx]

Don't und, why this? In short words.

[maple3142]

I think it is because of #92.

[tsanie]

@ivan-nginx Hide the specified page's sidebar in default (but in the config sidebar.display need to be 'post', for the other pages).

[ivan-nginx]

Default to force true maybe?

[tsanie]

Now, we could set the NexT config sidebar.display to 'hide', to force hide the sidebar.

But in order to the situation in #92 , I think we need a configure to set it for the each pages.

For example, now I need to set the sidebar.display to 'post' to shows the sidebar, when the post has a TOC. But in the meanwhile I need to hide the sidebar in another post, even it has the TOC.

[ivan-nginx]

I see. Can u set var by default to true? For around possible bugs in future.

[ivan-nginx]

var display = true above this.

[tsanie]

change the variable here, because the header.swig will be cached when using hexo g.

[tsanie]

Now here is the demo. (my theme config sidebar.display is 'post')

• post without a front-matter sidebar: https://tsanie.us/2018/01/10/lazyload-disqus/
  (it will display the sidebar automatically)
• post with a front-matter sidebar: false: https://tsanie.us/2018/01/15/setting-git-hooks/
  (it will hide the sidebar when the page loaded)
• post with a front-matter sidebar: true: https://tsanie.us/about/
  (it will display the sidebar automatically, even it has no TOC)

[sli1989]

it means toc control sidebar originally?
how about use front-matter to control sidebar in pages?

[tsanie]

@sli1989 Originally it has 2 conditions to control the sidebar, whether it has TOC and NexT config sidebar.display.

Now the PR is introducing a new condition, which defined in the front-matter page by page.

[sli1989]

@tsanie when sidebar.display=post and there are few words in the post content, the sidebar still note display.
i mean is there another way just use the attribute of front matter instead of add a new variable, which is more convenience for posted pages.

---

it's also useful for new custom page using sidebar: true, maybe use AND conditional .

[tsanie]

@sli1989 yeah, I think this PR could satisfy you. Just add the attribute like sidebar: true in the front matter of the post, the sidebar will force to show (even it has no TOC)

[sli1989]

how about sidebar: {{ page.title | page.sidebar | json_encode }}, ?
make sure the sidebar diaplay in post with titile when CONFIG.sidebar.display === 'post' || CONFIG.sidebar.display === 'always', don't need to add sidebar: true in front matter of posted pages where have few words (no toc situation).

[tsanie]

That will make a different change with the original logic. The original logic is the sidebar.display === 'post' || sidebar.display === 'always' AND the page has a TOC in the meanwhile.

Now the code is only add an additional option that allow the user to change it. I think it is better without a breaking change. 😃

[HaoweiCh]

hello bro, I just modified 1 place that can support this feature.. I didn't verify other schemes I use latest next & mist.

hope this can help you

// source/js/src/utils.js & line 228

   displaySidebar: function() {
-    if (!this.isDesktop() || this.isPisces() || this.isGemini()) {
+    if (!this.isDesktop() || this.isPisces() || this.isGemini() || CONFIG.page.sidebar===false) {
       return;
     }

I didn't know whether other place has to me modified , to my thought