Skip to content

Commit

Permalink
Update docs of sidebar
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenjoezhang committed Apr 26, 2024
1 parent 80fcac3 commit a26b2a1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 10 deletions.
2 changes: 1 addition & 1 deletion source/docs/theme-settings/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The `prefers-color-scheme` CSS media feature is used to bring Dark Mode to all 4

{% caniuse prefers-color-scheme @ current,past_1,past_2,past_3,past_4,past_5 %}

Theme NexT automatically shows Dark Mode if the OS prefered theme is dark. It's supported by macOS Mojave, iOS 13 and Android 10 or later. Relevant docs:
Theme NexT automatically shows Dark Mode if the OS preferred theme is dark. It's supported by macOS Mojave, iOS 13 and Android 10 or later. Relevant docs:
[How to use Dark Mode on your Mac](https://support.apple.com/en-us/HT208976)
[Use Dark Mode on your iPhone, iPad, or iPod touch](https://support.apple.com/en-us/HT210332)
[Dark theme | Android Developers](https://developer.android.com/guide/topics/ui/look-and-feel/darktheme)
Expand Down
31 changes: 22 additions & 9 deletions source/docs/theme-settings/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: NexT User Docs – Theme Settings – Sidebar

By default sidebar only shows in posts (have a table of content), and is placed in left side. You can change it by editing values under `sidebar` setting in {% label primary@NexT config file %}.

Sidebar has several options, including `position`, `width`, `display`, `padding` and `offset`.
Sidebar has several options, including `position`, `width_expanded`, `width_dual_column`, `display`, `padding` and `offset`.

{% tabs setting-sidebar %}
<!-- tab <code>position</code> -->
Expand All @@ -24,19 +24,32 @@ sidebar:

<!-- endtab -->

<!-- tab <code>width</code> -->
You can change sidebar width by specify `sidebar.width` setting in pixels, for example:
<!-- tab <code>width_expanded</code> -->
You can change sidebar width by specify `sidebar.width_expanded` setting in pixels, for example:

```yml NexT config file
sidebar:
width: 300
width_expanded: 320
```
{% note info %}
This option is commented out by default and values are:
This option is applicable to:
* Muse and Mist scheme
* Mobile of Pisces and Gemini scheme
* For Muse | Mist schemes: `320`
* For Pisces | Gemini schemes: `240`
{% endnote %}
<!-- endtab -->
<!-- tab <code>width_dual_column</code> -->
You can change sidebar width by specify `sidebar.width_dual_column` setting in pixels, for example:

```yml NexT config file
sidebar:
width_dual_column: 240
```

{% note info %}
This option is applicable to desktop of Pisces and Gemini scheme.

{% endnote %}
<!-- endtab -->
Expand Down Expand Up @@ -75,8 +88,8 @@ sidebar:
offset: 12
```

{% note danger %}
For now only Pisces / Gemini Schemes supports `offset` setting under **6.0.x** version or later.
{% note info %}
This option is applicable to Pisces and Gemini scheme.
{% endnote %}
<!-- endtab -->

Expand Down

0 comments on commit a26b2a1

Please sign in to comment.