Skip to content

Commit bc8d03d

Browse files
coder-lidacoder-lida
committed
first commit
0 parents  commit bc8d03d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+10577
-0
lines changed

‎.github/ISSUE_TEMPLATE/------.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: 使用遇到问题
3+
about: 使用遇到问题请先认真阅读文档，仍然无法解决可在文档页面下方留言。
4+
5+
---
6+
7+
如果你发现 无法使用 或者效果与示例有较大区别，可以使用hexo官方提供的用于单元测试的博客应用本主题查看样式是否正常，对比_config.yml文件排查问题。
8+
9+
## 下载单元测试：
10+
11+
Hexo官方的单元测试博客： [https://github.com/hexojs/hexo-theme-unit-test](https://github.com/hexojs/hexo-theme-unit-test)。
12+
如果你的系统是macOS，则可以使用hexo.sh脚本一键完成测试。
13+
14+
## 提问前请先认真阅读文档
15+
16+
文档：[https://xaoxuu.com/wiki/material-x/](https://xaoxuu.com/wiki/material-x/)

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
_site/
2+
.sass-cache/
3+
.jekyll-metadata
4+
.DS_Store

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 xaoxuu
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
# Material X
2+
3+
A minimalist card-style Hexo blog theme.
4+
5+
![](https://img.vim-cn.com/52/a54815c02ce232f11f54b2c547c1337828833c.png)
6+
7+
8+
#### Completely free modular and easy to customize design
9+
10+
- You can freely decide whether each page requires a cover, whether a cover requires a background image, how many images, whether a carousel is required, and how fast it is.
11+
- Freely decide whether each page needs sidebar, what cards are displayed in sidebar widgets, and in what order.
12+
- You can freely determine the main structure of each page (default articles + comments), and add cards as needed (share the card library with sidebar widgets).
13+
- You can freely decide whether the meta tag (date, update date, category, tag, share, reading statistics, sticky) of each article is displayed, whether it is placed at the beginning or the end of the article. Titles, thumbnails, small icons (for archiving pages), and page-specific music players are also counted as meta tags, but their positions are fixed.
14+
- Most buttons can be set as icons, text, target, nofollow, etc.
15+
- Easily change visual effects such as theme colors, custom fonts, margins, rounded corners, shadows, etc., and quickly implement dark theme.
16+
17+
#### Easy to extend
18+
19+
- Use the [import](https://xaoxuu.com/wiki/material-x/config/#import) field to easily import css and js into the theme.
20+
21+
#### Mobile optimization
22+
23+
- A lot of optimization for mobile layout.
24+
25+
#### Support for more features
26+
27+
- Supports 4 comment systems: Disqus, Gitalk, La BiLi and Valin comments.
28+
- Provide themed CDN, or customize CDN.
29+
- Use card design elements and interactive animations.
30+
- Use fontawesome 5.6.3 free icon.
31+
- Support APlayer player, can play the music of Netease cloud, QQ music, shrimp, cool dog platform and other servers.
32+
- Support non-garlic reading statistics, Baidu analysis, Google analysis.
33+
- Support rendering MathJax mathematical formula, optimized rendering effect.
34+
35+
36+
37+
<br>
38+
39+
## Blog Example
40+
41+
| Blog | Source Code | Instructions |
42+
| ----------------------------------- | -------------------------------------- | ------------------ |
43+
| [@mxclub](https://mxclub.github.io) | https://github.com/xaoxuu/blog-example | The default effect of the master branch |
44+
| [@xaoxuu](https://xaoxuu.com) | Not open source yet | myblog branch effect |
45+
46+
47+
- **For more examples, please see [#Example Blog](https://github.com/xaoxuu/hexo-theme-material-x/issues/97)**
48+
49+
50+
51+
<br>
52+
53+
## Download and install
54+
55+
### A. Full automatic installation using scripts (currently only macOS is supported)
56+
57+
1. Open a terminal and enter the following command to install the script, see [# hexo.sh](https://xaoxuu.com/wiki/hexo.sh/) for the script document.
58+
```bash
59+
curl -s https://xaoxuu.com/install | sh -s hexo.sh
60+
```
61+
62+
2. After successful installation, open a terminal on your blog path and enter the following command to install the theme and dependencies.
63+
```bash
64+
hexo.sh i x
65+
```
66+
67+
68+
69+
### B. Manual installation
70+
71+
1. Download theme to `themes /` folder
72+
```bash
73+
git clone https://github.com/xaoxuu/hexo-theme-material-x themes / material-x
74+
```
75+
76+
2. Then install the necessary dependencies
77+
```bash
78+
npm i -S hexo-generator-search hexo-generator-json-content hexo-renderer-less
79+
```
80+
81+
82+
83+
<br>
84+
85+
## Documentation
86+
87+
https://xaoxuu.com/wiki/material-x/
88+
89+
90+
<br>
91+
<br>
92+
<br>
93+
94+
# Material X
95+
96+
一个简约的卡片式Hexo博客主题。
97+
98+
![](https://img.vim-cn.com/52/a54815c02ce232f11f54b2c547c1337828833c.png)
99+
100+
101+
#### 完全自由的模块化、易于定制化设计
102+
103+
- 可以自由决定每个页面是否需要封面、封面是否需要背景图片、多少图片、是否需要轮播、速度如何。
104+
- 可以自由决定每个页面是否需要侧边栏、侧边栏小部件显示什么卡片、顺序如何。
105+
- 可以自由决定每个页面的主体结构（默认文章+评论），可以按需增加卡片（与侧边栏小部件共用卡片库）。
106+
- 可以自由决定每篇文章的meta标签（日期、更新日期、分类、标签、分享、阅读统计、置顶）显示与否、放置在文章开头还是末尾。标题、缩略图、小图标（用于归档页面）、页面专属的音乐播放器也算做meta标签，但是它们的位置固定。
107+
- 大部分按钮可以自由设置图标、文字、target、nofollow等
108+
- 方便更换主题色、自定义字体、边距、圆角、阴影等视觉效果，快速实现暗色主题。
109+
110+
#### 易于扩展
111+
112+
- 使用 [import](https://xaoxuu.com/wiki/material-x/config/#import) 字段方便导入css和js到主题中。
113+
114+
#### 移动端优化
115+
116+
- 针对移动端布局进行了大量优化。
117+
118+
#### 更多功能的支持
119+
120+
- 支持4种评论系统：Disqus、Gitalk、来必力和Valine评论。
121+
- 提供主题CDN，也可自定义CDN。
122+
- 使用卡片设计元素以及交互动效。
123+
- 使用 fontawesome 5.6.3 免费版图标。
124+
- 支持APlayer播放器，可以播放网易云、QQ音乐、虾米、酷狗平台以及其它服务器的音乐。
125+
- 支持不蒜子阅读统计、百度分析、Google分析。
126+
- 支持渲染MathJax数学公式，优化了渲染效果。
127+
128+
129+
130+
<br>
131+
132+
## 博客示例
133+
134+
| 博客 | 源码 | 说明 |
135+
| ----------------------------------- | -------------------------------------- | ------------------ |
136+
| [@mxclub](https://mxclub.github.io) | https://github.com/xaoxuu/blog-example | master分支默认效果 |
137+
| [@xaoxuu](https://xaoxuu.com) | 暂未开源 | myblog分支效果 |
138+
139+
140+
- **更多示例请见 [#示例博客](https://github.com/xaoxuu/hexo-theme-material-x/issues/97)**
141+
142+
143+
144+
<br>
145+
146+
## 下载安装
147+
148+
### A. 使用脚本全自动安装（目前仅支持macOS）
149+
150+
1. 打开终端输入下面命令安装脚本，脚本文档见[#hexo.sh](https://xaoxuu.com/wiki/hexo.sh/)。
151+
```bash
152+
curl -s https://xaoxuu.com/install | sh -s hexo.sh
153+
```
154+
155+
2. 安装成功后，在你的博客路径打开终端，输入下面命令即可安装主题和依赖包。
156+
```bash
157+
hexo.sh i x
158+
```
159+
160+
161+
162+
### B. 手动安装
163+
164+
1. 下载主题到 `themes/` 文件夹
165+
```bash
166+
git clone https://github.com/xaoxuu/hexo-theme-material-x themes/material-x
167+
```
168+
169+
2. 然后安装必要的依赖包
170+
```bash
171+
npm i -S hexo-generator-search hexo-generator-json-content hexo-renderer-less
172+
```
173+
174+
175+
176+
<br>
177+
178+
## 文档
179+
180+
https://xaoxuu.com/wiki/material-x/

0 commit comments

Comments
 (0)