chore(doc): write en getting started guide
ppoffice
parent
91ffce19be
commit
7ab61914d3
|
|
@ -6,40 +6,49 @@ tags:
|
|||
- Icarus User Guide
|
||||
language: en
|
||||
---
|
||||
Icarus is a simple, delicate, and modern theme for the static site generator Hexo.
|
||||
It allows you to set up a single or multiple-column (up to three columns) blog with its versatile layout configuration.
|
||||
Additionally, it offers plentiful plugins and pluggable widgets so that you can enable the features you want in no time.
|
||||
And with the all-new API designing, Icarus makes the development of this theme painless for developers and users.
|
||||
Welcome to the Icarus documentation site!
|
||||
Icarus is a simple, delicate, and modern theme for the static site generator Hexo.
|
||||
It strives to be elegant in design while simple and straightforward to use.
|
||||
Its versatile and flexible configuration system to let power users lay out their sites to the finest details.
|
||||
Icarus also offers a wide range of plugins and widgets to meet your various customization and optimization
|
||||
needs.
|
||||
Moreover, its refreshed internal implementation enables better IDE support and third-party integration, which
|
||||
open to a sea of improvement possibilities.
|
||||
|
||||
<!-- more -->
|
||||
|
||||
<div class="notification is-success is-size-6">
|
||||
This article is also available in: <a href="{% post_path zh-CN/Getting-Started %}">简体中文</a>.
|
||||
<article class="message message-immersive is-primary">
|
||||
<div class="message-body">
|
||||
<i class="fas fa-lightbulb mr-2"></i>
|
||||
This article is also available in <a href="{% post_path zh-CN/Getting-Started %}">简体中文</a>.
|
||||
</div>
|
||||
</article>
|
||||
|
||||
To set up Icarus in your blog, please download the tarball from the GitHub and extract it to your Hexo blog's theme
|
||||
Before you continue to the installation of Icarus, take some time to review the
|
||||
[Hexo documentation](https://hexo.io).
|
||||
To install Icarus, download the tarball from the GitHub and extract it to your Hexo blog's theme
|
||||
directory.
|
||||
Alternatively, you can run the following command:
|
||||
Alternatively, you can use Git to clone the Icarus repository to the `themes` directory:
|
||||
|
||||
{% codeblock "Git Bash/Shell" %}
|
||||
git clone https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus -b <version number> --depth 1
|
||||
{% endcodeblock %}
|
||||
|
||||
You may omit the `-b <version number>` to get the latest development version of Icarus.
|
||||
You may also leave `--depth 1` out if you want to download full Git history of Icarus as well.
|
||||
Furthermore, you can install Icarus as a Git submodule by executing the following command:
|
||||
You may omit `-b <version number>` to get the latest development version of Icarus.
|
||||
You may also leave `--depth 1` out if you want to download full Git commit history of Icarus as well.
|
||||
Furthermore, you can install Icarus as a Git submodule with the following command:
|
||||
|
||||
{% codeblock "Git Bash/Shell" %}
|
||||
git submodule add https://github.com/ppoffice/hexo-theme-icarus.git themes/icarus
|
||||
{% endcodeblock %}
|
||||
|
||||
Next, replace the theme setting in your blog's `_config.yml` file:
|
||||
Next, activate Icarus in your blog's `_config.yml` file:
|
||||
|
||||
{% codeblock _config.yml lang:yaml %}
|
||||
theme: icarus
|
||||
{% endcodeblock %}
|
||||
|
||||
or use the `hexo` CLI to change the theme setting:
|
||||
or use the `hexo` command to change the theme to Icarus:
|
||||
|
||||
{% codeblock "Shell" %}
|
||||
hexo config theme icarus
|
||||
|
|
@ -48,18 +57,19 @@ hexo config theme icarus
|
|||
Finally, use the following command to start the Hexo local server and begin composing!
|
||||
|
||||
{% codeblock "Shell" %}
|
||||
hexo s
|
||||
hexo server
|
||||
{% endcodeblock %}
|
||||
|
||||
You can check out the [Icarus User Guide](/hexo-theme-icarus/tags/Icarus-User-Guide/) article series to learn more
|
||||
about Icarus and its configuration.
|
||||
Also, you can refer to the source code of this site for more examples by fetching the
|
||||
[`site` branch](https://github.com/ppoffice/hexo-theme-icarus/tree/site) of Icarus from GitHub.
|
||||
You can check out the [Icarus User Guide](/hexo-theme-icarus/tags/Icarus-User-Guide/) to learn more about the
|
||||
theme, widgets, and plugins.
|
||||
Additionally, you can refer to the source code of this site for more examples.
|
||||
It is in the [`site` branch](https://github.com/ppoffice/hexo-theme-icarus/tree/site) of the Icarus repository
|
||||
on GitHub.
|
||||
|
||||
**Additional Resources**
|
||||
|
||||
The following are some additional resources that can help you take a step further into customizing your site.
|
||||
You can also add a link to your Icarus tutorial below by click [this link](https://github.com/ppoffice/hexo-theme-icarus/edit/site/source/_posts/en/Getting-Started.md).
|
||||
Here are some other resources that you may find useful to further customize your site.
|
||||
You can also submit your Icarus tutorial through [this link](https://github.com/ppoffice/hexo-theme-icarus/edit/site/source/_posts/en/Getting-Started.md).
|
||||
|
||||
<div class="menu-list is-size-6">
|
||||
<a href="https://hexo.io/docs/index.html"><i class="fas fa-bookmark mr-2"></i> Hexo documentation</a>
|
||||
|
|
@ -67,8 +77,11 @@ You can also add a link to your Icarus tutorial below by click [this link](https
|
|||
|
||||
<br>
|
||||
|
||||
<div class="notification is-warning is-size-6">
|
||||
<article class="message message-immersive is-warning">
|
||||
<div class="message-body">
|
||||
<i class="fas fa-exclamation-triangle mr-2"></i>
|
||||
Something wrong with this article? Click <a href="https://github.com/ppoffice/hexo-theme-icarus/edit/site/source/_posts/en/Getting-Started.md">here</a> to submit your revision.
|
||||
</div>
|
||||
</article>
|
||||
|
||||
<a style="background-color:black;color:white;text-decoration:none;padding:4px 6px;font-size:12px;line-height:1.2;display:inline-block;border-radius:3px" href="https://www.vecteezy.com/free-vector/vector-landscape" target="_blank" rel="noopener noreferrer" title="Vector Landscape Vectors by Vecteezy"><span style="display:inline-block;padding:2px 3px"><svg xmlns="http://www.w3.org/2000/svg" style="height:12px;width:auto;position:relative;vertical-align:middle;top:-1px;fill:white" viewBox="0 0 32 32"><path d="M20.8 18.1c0 2.7-2.2 4.8-4.8 4.8s-4.8-2.1-4.8-4.8c0-2.7 2.2-4.8 4.8-4.8 2.7.1 4.8 2.2 4.8 4.8zm11.2-7.4v14.9c0 2.3-1.9 4.3-4.3 4.3h-23.4c-2.4 0-4.3-1.9-4.3-4.3v-15c0-2.3 1.9-4.3 4.3-4.3h3.7l.8-2.3c.4-1.1 1.7-2 2.9-2h8.6c1.2 0 2.5.9 2.9 2l.8 2.4h3.7c2.4 0 4.3 1.9 4.3 4.3zm-8.6 7.5c0-4.1-3.3-7.5-7.5-7.5-4.1 0-7.5 3.4-7.5 7.5s3.3 7.5 7.5 7.5c4.2-.1 7.5-3.4 7.5-7.5z"></path></svg></span><span style="display:inline-block;padding:2px 3px">Vector Landscape Vectors by Vecteezy</span></a>
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit 83b8aca81d8ac7e7ed0caaccf9c5fd49375206d7
|
||||
Subproject commit 5ff135cccd1f4eec3081c4a513076cb80075a513
|
||||
Loading…
Reference in New Issue