Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenjoezhang committed Aug 3, 2020
1 parent ea561e0 commit be80d69
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 17 deletions.
2 changes: 0 additions & 2 deletions deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ echo "=============================================================="
hexo config root /muse/
hexo config theme_config.scheme Muse
hexo config theme_config.sidebar.position right
hexo config theme_config.back2top.sidebar false
hexo clean && hexo g

echo "${lred}`mv -v public muse`${norm}"
Expand All @@ -87,7 +86,6 @@ echo "=============================================================="
hexo config root /pisces/
hexo config theme_config.scheme Pisces
hexo config theme_config.sidebar.position left
hexo config theme_config.back2top.sidebar true
hexo clean && hexo g

echo "${lred}`mv -v public pisces`${norm}"
Expand Down
8 changes: 5 additions & 3 deletions source/docs/advanced-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,22 @@ This feature is located under `vendors` section in {% label primary@theme config
```yml next/_config.yml
vendors:
# The CDN provider of NexT internal scripts.
# Available values: local, jsdelivr, unpkg
# Available values: local | jsdelivr | unpkg
internal: local
# The default CDN provider of third-party plugins.
# Available values: local, jsdelivr, unpkg, cdnjs
# Available values: local | jsdelivr | unpkg | cdnjs
# Dependencies for `plugins: local`: https://github.com/next-theme/plugins
plugins: jsdelivr

# In the following settings, you can specify the CDN link for each plugin.
# If left blank, the default CDN provider set by `plugins` option will be used.

# Anime.js
# For more information: https://animejs.com
anime:

# Font Awesome
# For more information: https://fontawesome.com
fontawesome:

...
Expand All @@ -51,7 +53,7 @@ The reason that jsDelivr is chosen to deliver our third-party plugins is because

And it could automatically minify the JS and CSS files, even if you don't have the minified version. Just use the `filename.min.js` or the `filename.min.css` to replace the file above. For more information: https://www.jsdelivr.com/features

And we also provide other optional CDNs, including the famous [UNPKG](https://unpkg.com) and [CDNJS](https://cdnjs.com/). Set `plugins` to `unpkg` or `cdnjs` to load them from different CDN provider.
And we also provide other optional CDNs, including the famous [UNPKG](https://unpkg.com) and [CDNJS](https://cdnjs.com). Set `plugins` to `unpkg` or `cdnjs` to load them from different CDN provider.

{% note warning %}
Particularly, if you are a Chinese blogger or most of your visits come from China, please note that **the CDNJS is blocked in some parts of China**, don't use it as your CDN provider.
Expand Down
2 changes: 1 addition & 1 deletion source/docs/getting-started/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ GitLab offers a continuous integration service and pages service. If you add a `

Now, your static website is available at `https://yourname.gitlab.io/project` that is similar to GitHub. [More GitLab Pages config in here](https://gitlab.com/help/user/project/pages/index.md).

Of course, you also can pulish static website on GitHub Pages or others pages service. There are two ways to configure `.gitlab-ci.yml`:
Of course, you can also pulish static website on GitHub Pages or others pages service. There are two ways to configure `.gitlab-ci.yml`:

{% tabs Gitlab CI %}
<!-- tab <code>HTTPS</code> -->
Expand Down
15 changes: 10 additions & 5 deletions source/docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ $ git clone https://github.com/next-theme/hexo-theme-next themes/next
{% endtabs %}

{% note primary %}
You also can read [detailed installation instructions](/docs/getting-started/installation.html) if you want any other installation variant.
You can also read [detailed installation instructions](/docs/getting-started/installation.html) if you want any other installation variant.
{% endnote %}

{% note warning %}
Expand Down Expand Up @@ -242,13 +242,18 @@ menu:
archives: /archives/ || fa fa-archive
Docs:
default: /docs/ || fa fa-book
Getting Started:
default: /getting-started/ || fa fa-flag
Installation: /installation.html || fa fa-download
Configuration: /configuration.html || fa fa-wrench
Third Party Services:
default: /third-party-services/ || fa fa-plug
Algolia Search: /algolia-search/ || fa fa-search-plus
default: /third-party-services/ || fa fa-puzzle-piece
Math Equations: /math-equations.html || fa fa-square-root-alt
Comment Systems: /comments.html || far fa-comment
```

{% note info %}
If your site runs in a sub-directory, please remove the prefix `/` from the link.
{% note warning %}
A `default` page is required for each sub-menu item.
{% endnote %}

By default NexT shows the icons of menu items without badges.
Expand Down
2 changes: 1 addition & 1 deletion source/docs/theme-settings/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ avatar:
<!-- endtab -->

<!-- tab Absolute URL from Internet -->
You also can specify any external URL with absolute path to image: `http(s)://example.com/avatar.png`
You can also specify any external URL with absolute path to image: `http(s)://example.com/avatar.png`
<!-- endtab -->
{% endsubtabs %}
<!-- endtab -->
Expand Down
4 changes: 2 additions & 2 deletions source/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ theme_config:
scheme: Gemini
```
Here will nothing happen because indentation not keeped up. Hexo just can't see these parameters because subparameters (children parameters of `theme_config` parameter) are not exists. Let's see [same configuration with indents](#2-spaces-indents-2).
Nothing will happen here because indentation not keeped up. Hexo just can't read these parameters because subparameters (children parameters of `theme_config` parameter) does not exist. Let's see [same configuration with indents](#2-spaces-indents-2).
<!-- endtab -->

<!-- tab {% label success@Working Normally %}-->
Expand All @@ -81,7 +81,7 @@ For Hexo before version 4.0, when backtick code block(s) exists inside other tag

{% tabs backtick-code-block %}
<!-- tab {% label success@Tagged Code Block %} -->
Instead of [Backtick Code Block](https://hexo.io/docs/tag-plugins#Backtick-Code-Block) you also can use tagged [Code Block](https://hexo.io/docs/tag-plugins#Code-Block).
Instead of [Backtick Code Block](https://hexo.io/docs/tag-plugins#Backtick-Code-Block) you can also use tagged [Code Block](https://hexo.io/docs/tag-plugins#Code-Block).
But in rare cases standard code block can obtain errors inside other tags.
<!-- endtab -->

Expand Down
7 changes: 4 additions & 3 deletions source/highlight/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
Configuration
</div>
<div class="card-body">
<p>Which code highlight engine do you prefer? (Prism requires Hexo v5 or later.)</p>
<p>Which code highlight engine do you prefer?</p>
<div class="alert alert-danger" role="alert">Prism requires Hexo v5 or later.</div>
<div class="input-group mb-3">
<div class="input-group-prepend">
<label class="input-group-text" for="engine">Engine</label>
Expand All @@ -55,7 +56,7 @@
<select class="custom-select" id="theme">
</select>
</div>
<p class="note d-none">Install <code>prism-themes</code> with <code>npm install prism-themes</code> command in Hexo root directory first.</p>
<div class="alert alert-danger d-none" role="alert">Install <code>prism-themes</code> with <code>npm install prism-themes</code> command in Hexo root directory first.</div>
<p>Configuration in NexT <code>_config.yml</code></p>
<pre class="render next"></pre>
</div>
Expand Down Expand Up @@ -257,7 +258,7 @@
theme: () => {
let href = this.element.theme.value;
this.style.getStyle(href);
document.querySelector('.note').classList.toggle('d-none', !href.startsWith(source.src + this.style.origin.themes.src));
document.querySelectorAll('.alert')[1].classList.toggle('d-none', !href.startsWith(source.src + this.style.origin.themes.src));
},
language: () => {},
code: () => {}
Expand Down

0 comments on commit be80d69

Please sign in to comment.