Skip to content

Commit

Permalink
Remove dollar signs before commands
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenjoezhang committed Apr 23, 2024
1 parent ff297ff commit 80fcac3
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 51 deletions.
24 changes: 12 additions & 12 deletions source/docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ _config.yml node_modules package-lock.json package.json scaffolds source t
If you are new to Node.js or Hexo, you can also modify the source code of an existing Hexo website instead of creating a new one, to help you understand how Hexo works. In fact, the document you are reading is generated by Hexo with NexT, and you can install it with the following command:

```bash
$ git clone https://github.com/next-theme/theme-next-docs
$ cd theme-next-docs
$ npm install
git clone https://github.com/next-theme/theme-next-docs
cd theme-next-docs
npm install
```

{% endnote %}
Expand All @@ -44,8 +44,8 @@ If you're using Hexo 5.0 or later, the simplest way to install is through npm.
Open your Terminal, change to Hexo {% label info@site root directory %} and install NexT theme:

```bash
$ cd hexo-site
$ npm install hexo-theme-next
cd hexo-site
npm install hexo-theme-next
```
<!-- endtab -->

Expand All @@ -55,8 +55,8 @@ If you know about [Git](https://git-scm.com), you can clone the whole repository
Open your terminal, change to Hexo {% label info@site root directory %} and clone the latest master branch of NexT theme:

```bash
$ cd hexo-site
$ git clone https://github.com/next-theme/hexo-theme-next themes/next
cd hexo-site
git clone https://github.com/next-theme/hexo-theme-next themes/next
```
<!-- endtab -->
{% endtabs %}
Expand All @@ -74,8 +74,8 @@ A new version of NexT will be released every month. Please read the [release not
If you have installed NexT theme through npm, you can upgrade it to the latest version by re-installing it:

```bash
$ cd hexo-site
$ npm install hexo-theme-next@latest
cd hexo-site
npm install hexo-theme-next@latest
```

Note that any local changes to the theme inside `node_modules` directory will be lost when you run `npm install`. If you have made changes to the theme, you should back up the changes before running `npm install`, and then restore the changes after the installation is complete.
Expand All @@ -87,9 +87,9 @@ It's not recommended to modify the theme files in `node_modules` directory. To c
After a new version of the theme is released, you can use `git pull` to update it to the latest master branch:

```sh
$ cd hexo-site
$ cd themes/next
$ git pull origin master
cd hexo-site
cd themes/next
git pull origin master
```

If you have made changes to the theme, you may encounter merge conflicts (error message like **«Commit your changes or stash them before you can merge»**) when running `git pull`. You can bypass merge conflicts by using the `Commit`, `Stash` or `Reset` commands for local changes. See [here](https://stackoverflow.com/a/15745424/5861495) how to do it.
Expand Down
16 changes: 8 additions & 8 deletions source/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ If you're using Hexo 5.0 or later, you can install `hexo-theme-next` through npm
{% tabs using-npm %}
<!-- tab Latest Release Version -->
```bash
$ npm install hexo-theme-next@latest
npm install hexo-theme-next@latest
```

This variant will install the **latest release version**.
<!-- endtab -->

<!-- tab Specific Release Version -->
```bash
$ npm install [email protected]
npm install [email protected]
```

This variant will install the **specific release version**.
Expand All @@ -61,13 +61,13 @@ This variant will install the **specific release version**.
{% tabs using-git %}
<!-- tab Latest Master Branch -->
```bash
$ git clone https://github.com/next-theme/hexo-theme-next themes/next
git clone https://github.com/next-theme/hexo-theme-next themes/next
```

Or download via mirror on GitLab:

```bash
$ git clone https://gitlab.com/hexo-theme-next/hexo-theme-next themes/next
git clone https://gitlab.com/hexo-theme-next/hexo-theme-next themes/next
```

This variant will install the **whole repository** (with `.git` directory inside).
Expand Down Expand Up @@ -97,25 +97,25 @@ HEAD is now at f27e45b Release v8.0.0
If you want to switch on latest release version without defining tag (optional)

```bash
$ git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
```

And if you want to switch back on master branch, input this command:

```bash
$ git checkout master
git checkout master
```
<!-- endtab -->

<!-- tab Specific Release Version -->
```bash
$ git clone --branch v8.0.0 https://github.com/next-theme/hexo-theme-next themes/next
git clone --branch v8.0.0 https://github.com/next-theme/hexo-theme-next themes/next
```

Or download via mirror on GitLab:

```bash
$ git clone --branch v8.0.0 https://gitlab.com/hexo-theme-next/hexo-theme-next themes/next
git clone --branch v8.0.0 https://gitlab.com/hexo-theme-next/hexo-theme-next themes/next
```

This variant will install the **specific release version** (with `.git` directory inside).
Expand Down
16 changes: 8 additions & 8 deletions source/docs/theme-settings/custom-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Next allows users to add custom pages in menu.
Change to {% label info@site root directory %} in your terminal. Use `hexo new page custom-name` to create a new `custom-name` page:

```bash
$ cd hexo-site
$ hexo new page custom-name
cd hexo-site
hexo new page custom-name
```
<!-- endtab -->

Expand Down Expand Up @@ -85,8 +85,8 @@ Adding «Tags» page and show «Tags» link in menu. «Tags» page will show all
Change to {% label info@site root directory %} in your terminal. Use `hexo new page tags` to create a new `tags` page:

```bash
$ cd hexo-site
$ hexo new page tags
cd hexo-site
hexo new page tags
```
<!-- endtab -->

Expand Down Expand Up @@ -187,8 +187,8 @@ calendar:
Change to {% label info@site root directory %} in your terminal. Use `hexo new page schedule` to create a new `schedule` page:

```bash
$ cd hexo-site
$ hexo new page schedule
cd hexo-site
hexo new page schedule
```
<!-- endtab -->

Expand Down Expand Up @@ -220,8 +220,8 @@ menu:
In your terminal, change to the `source` folder of {% label info@site root directory %}. Create a new folder called `404`, then create a new page in it:

```bash
$ cd hexo-site
$ hexo new page 404
cd hexo-site
hexo new page 404
```

Make sure `relative_link` is disabled in {% label info@Hexo config file %}:
Expand Down
8 changes: 4 additions & 4 deletions source/docs/theme-settings/posts.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ post_meta:
Install `hexo-word-counter` by executing the following command in {% label info@site root dir %}:

```bash
$ npm install hexo-word-counter
$ hexo clean
npm install hexo-word-counter
hexo clean
```
<!-- endtab -->

Expand Down Expand Up @@ -265,8 +265,8 @@ NexT supports the related posts functionality according to [hexo-related-posts](
Install `hexo-related-posts` by executing the following command in {% label info@site root dir %}:

```bash
$ npm install hexo-related-posts
$ hexo clean
npm install hexo-related-posts
hexo clean
```
<!-- endtab -->

Expand Down
2 changes: 1 addition & 1 deletion source/docs/theme-settings/seo.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ exturl_icon: true

Then run the following command in {% label info@site root dir %} to ensure that `exturl` can be enabled or disabled correctly:
```bash
$ hexo clean
hexo clean
```

### Webmaster Tools
Expand Down
2 changes: 1 addition & 1 deletion source/docs/third-party-services/external-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ lazyload: true
Then run the following command in {% label info@site root dir %} to ensure that `lazyload` can be enabled or disabled correctly:

```bash
$ hexo clean
hexo clean
```

### Pangu Autospace
Expand Down
12 changes: 6 additions & 6 deletions source/docs/third-party-services/math-equations.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,22 +145,22 @@ If you use KaTeX to render Math Equations, you can choose one of the Markdown re
<!-- tab hexo-renderer-markdown-it-plus -->

```bash
$ npm un hexo-renderer-marked
$ npm i hexo-renderer-markdown-it-plus
npm un hexo-renderer-marked
npm i hexo-renderer-markdown-it-plus
```
<!-- endtab -->

<!-- tab hexo-renderer-markdown-it -->

```bash
$ npm un hexo-renderer-marked
$ npm i hexo-renderer-markdown-it
npm un hexo-renderer-marked
npm i hexo-renderer-markdown-it
```

If you use `hexo-renderer-markdown-it`, you also need to install `markdown-it-katex`:

```bash
$ npm i markdown-it-katex
npm i markdown-it-katex
```

And then in {% label info@Hexo config file %} you need to add `markdown-it-katex` as a plugin for `hexo-renderer-markdown-it`:
Expand Down Expand Up @@ -212,7 +212,7 @@ math:
After setting up the math rendering engine or installing / uninstalling the Markdown renderer, please execute `hexo clean`. Run standard Hexo generate, deploy process or start the server to test whether the plugin is working properly:

```bash
$ hexo clean && hexo g -d
hexo clean && hexo g -d
# or hexo clean && hexo s
```

Expand Down
20 changes: 10 additions & 10 deletions source/docs/third-party-services/search-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ Algolia requires users to upload their search index data either manually or via
Install and configure [Hexo Algolia](https://github.com/oncletom/hexo-algolia) in your Hexo directory.

```bash
$ cd hexo-site
$ npm install hexo-algolia
cd hexo-site
npm install hexo-algolia
```

In your {% label info@Hexo config file %}, add the following configuration and replace the `Application ID`, `Search-only API key` and `indexName` with corresponding fields obtained at Algolia.
Expand All @@ -57,10 +57,10 @@ algolia:
Run the following command to upload index data, keep a weather eye out the output of the command.
```bash
$ export HEXO_ALGOLIA_INDEXING_KEY=High-privilege API key # Use Git Bash
export HEXO_ALGOLIA_INDEXING_KEY=High-privilege API key # Use Git Bash
# set HEXO_ALGOLIA_INDEXING_KEY=High-privilege API key # Use Windows command line
$ hexo clean
$ hexo algolia
hexo clean
hexo algolia
```

![Reload Index](/images/algolia-5.png)
Expand All @@ -69,8 +69,8 @@ $ hexo algolia
Install and configure [Hexo Algoliasearch](https://github.com/LouisBarranqueiro/hexo-algoliasearch) in your Hexo directory.

```bash
$ cd hexo-site
$ npm install hexo-algoliasearch
cd hexo-site
npm install hexo-algoliasearch
```

In your {% label info@Hexo config file %}, add the following configuration and replace the `Application ID`, `Search-only API key`, `High-privilege API key` and `indexName` with corresponding fields obtained at Algolia.
Expand All @@ -96,8 +96,8 @@ algolia:
Run the following command to upload index data, keep a weather eye out the output of the command.
```bash
$ hexo clean
$ hexo algolia
hexo clean
hexo algolia
```
<!-- endtab -->
{% endsubtabs %}
Expand Down Expand Up @@ -126,7 +126,7 @@ Local search does not require any external 3rd-party services and can be extra i
Install `hexo-generator-searchdb` by executing the following command in {% label info@site root dir %}:

```bash
$ npm install hexo-generator-searchdb
npm install hexo-generator-searchdb
```
<!-- endtab -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Adding article reading times counting to NexT theme. Documentation how to set th
Install `hexo-leancloud-counter-security` by executing the following command in {% label info@site root dir %}:

```bash
$ npm install hexo-leancloud-counter-security
npm install hexo-leancloud-counter-security
```
<!-- endtab -->

Expand Down

0 comments on commit 80fcac3

Please sign in to comment.