Skip to content

Commit

Permalink
ADD: footer_text, LICENSE & version bump to v0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
huangyuzhang committed May 28, 2019
2 parents dfaf8e4 + 6ec5cb6 commit 108c286
Show file tree
Hide file tree
Showing 8 changed files with 78 additions and 21 deletions.
31 changes: 19 additions & 12 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
# CHANGELOG

## [v0.3.0](#) (TBA)
## [v1.0.0](#) (TBA)
### NEW
- [x] **comment**: support gitalk (close: [#19](../../issues/19)); site switch `show_comment` (see README)
- [x] **i18n**: translation support
- [x] **showcase**: showcase section for homepage use site switch `show_showcase` (see README)
- [x] **css variable**: main-color, etc. (testing)
- [ ] **search**: search system (todo)
- [ ] **post list**: create a page to list all posts.
- [ ] **collection**: support collections.
- [ ] **search**: support search system
- [ ] **README TOC**: better documentation

## [v0.3.0](https://github.com/huangyuzhang/Fizzy-Theme/releases/tag/v0.3.0) (2019.05.28)
### NEW
- **comment**: support gitalk (close: [#19](../../issues/19)); site switch `show_comment` (see README)
- **i18n**: translation support
- **showcase**: showcase section for homepage use site switch `show_showcase` (see README)
- **css variable**: main-color, etc. (testing)
- **custom footer text**: custom footer text by define a `var footer_text` (see README).

### MOD
- [x] **optimization**: boost loading speed for pages and posts (move js position).
- [x] **LaTeX**: switch to KaTeX. (close: [#13](../../issues/13))
- [x] **Navbar**: TOC scrolling with offset the top navbar
- [x] **post**: style modifications
- **optimization**: boost loading speed for pages and posts (move js position).
- **LaTeX**: switch to KaTeX. (close: [#13](../../issues/13))
- **Navbar**: TOC scrolling with offset the top navbar
- **post**: style modifications

### DEL
- [x] **carousel**: replaced by **showcase**
- [x] **deprecated CSS**: deleted unused CSS stylesheets to minify theme's file size.
- **carousel**: replaced by **showcase**
- **deprecated CSS**: deleted unused CSS stylesheets to minify theme's file size.

## [v0.2.2](https://github.com/huangyuzhang/Fizzy-Theme/releases/tag/v0.2.2) (2019.05.17)
### NEW
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 Yuzhang Huang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
13 changes: 11 additions & 2 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,21 @@
### 自定义模板
- **标签目录**: 使用模板 `Tag Archive` 来为标签添加一个目录页。([demo](https://fizzy.cc/tag/))。
- **全宽**: 使用模板 `Full Width` 来使用全宽的文章模板。([demo](https://fizzy.cc/fizzy-theme/))。
- **启用目录**: 使用模板 `Post With Toc` 来启用文章的目录抓取功能,详见[#目录](#目录)。 ([demo](https://fizzy.cc/fizzy-theme/))
- **启用目录**: 使用模板 `Post With Toc` 来启用文章的目录抓取功能,详见[#内页目录](#内页目录)。 ([demo](https://fizzy.cc/fizzy-theme/))
- **报告**: 为学术报告定制的页面 (计划中)

### 自定义CSS
修改 `assets/css/custom.css` 文件中的css变量来修改主题的颜色。

### 自定义底部文字
在 Ghost后台 -> Code injection -> `Site Header` 中添加以下代码并自定义来替换网站底部默认的 “Made with ❤️ in London”。

```javascript
<script>
var footer_text = "修改成你的自定义底部文字,可以包含HTML代码,但需要注意引号的使用";
</script>
```

### 评论系统
因为 Ghost 目前不包含评论系统,我们需要通过第三方工具或库来实现评论系统。

Expand Down Expand Up @@ -112,7 +121,7 @@ Fizzy 主题使用了 Prism.js 作为代码高亮解决方案,Fizzy主题默

访问 [自定义Prismjs][custom-prism] 来勾选你需要的语言。然后下载 js 和 css 文件以替换 `assets` 目录中的对应文件: `prism.js``prism.css`

### 目录
### 内页目录
目前 Fizzy 主题支持两种控制文章内章节目录的方法:
1.`Post Header`(单篇文章) 或者 `Site Header`(全站) 中插入如下代码(Code injection):
```javascript
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,15 @@ The left slider carousel part detects the internal tag `#carousel`. The right pa
### Custom CSS
Simply edit the variables in `assets/css/custom.css` to customize your theme coloring.

### Custom Footer Text
Define a variable `footer_text` in the `Site Header` as below to replaced the default: "Made with ❤️ in London" text at the bottom.

```javascript
<script>
var footer_text = "YOUR FOOTER TEXT HERE";
</script>
```

### :speech_balloon: Comment System
Due to Ghost itself doesn't have a comment system, we need to use third party solutions for this. Some options are: [DISQUS][disqus], [Gitalk][gitalk], [Valine][valine] and [Vssue][vssue]. By default, Fizzy has Gitalk and DISQUS integrated. Skip the following if you do not need the comment system.

Expand Down Expand Up @@ -144,7 +153,7 @@ See [CHANGELOG.md](./CHANGELOG.md)
- [Gitalk][gitalk] - A Github issued based comment system (since v0.3.0)

## :bug: Bug Report & :dart: Features Request
If you find a bug, thinking about something to be improved or even want new features, please feel free to post an issue and label appropriately.
If you find a bug, thinking about something to be improved or even want new features, please feel free to post an issue and label accordingly.

Alternatively if you are familiar with them development, you could start to contribute to this project.

Expand Down
4 changes: 2 additions & 2 deletions assets/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -854,13 +854,13 @@ html,body{

/* ====================== footer ====================== 2019.04.12 */
.declare a {
color:#000;
color:#666;
word-break: break-word;
transition: all .25s;

}
.declare a:hover {
box-shadow: var(--main-color) 0 -1px 0 inset;
color: var(--link-color-hover);
}

/* ====================== error page ====================== 2019.05.10 */
Expand Down
2 changes: 2 additions & 0 deletions default.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@
if (show_showcase){$('#showcase').removeClass("is-hidden");};
</script>



{{!-- Fontawesome icons --}}
<script defer src="https://use.fontawesome.com/releases/v5.8.1/js/all.js" integrity="sha384-g5uSoOSBd7KkhAMlnQILrecXvzst9TdC09/VM+pjDTCM+1il8RHz5fKANTFFb+gQ" crossorigin="anonymous"></script>
</body>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "fizzy",
"description": "A tasty blogging theme for Ghost.",
"version": "0.2.2",
"version": "0.3.0",
"author": {
"name": "Yuzhang Huang",
"email": "[email protected]"
Expand Down
15 changes: 12 additions & 3 deletions partials/footer.hbs
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
<footer class="footer is-centered" style="padding-bottom:3rem;">
<div class="content has-text-centered">
<p class="copyright">&copy; {{date format="YYYY"}} <a href="{{@site.url}}"><strong class="has-text-grey-darker">{{@site.title}}</strong></a></p>
<p class="declare has-text-grey">Made with <span style="color:#fb3c3b;"><i class="fas fa-heart is-danger"></i></span> in <strong>London</strong>.
Using <a href="https://fizzy.cc/fizzy-theme/" target="_blank" rel="noopener noreferrer"><strong>The Fizzy theme</strong></a> & published with <a href="https://ghost.org/" target="_blank" rel="noopener noreferrer nofollow"><strong>Ghost</strong></a>
<p class="declare has-text-grey">
<script>
if (typeof footer_text == 'undefined') {
var footer_text = "Made with <span style='color:#fb3c3b;'><i class='fas fa-heart is-danger'></i></span> in <strong>London</strong>.";
};
</script>
<script>
document.write(footer_text);
</script>
<br>Using <a href="https://fizzy.cc/fizzy-theme/" target="_blank" rel="noopener noreferrer"><strong>The Fizzy theme</strong></a> | Published with <a href="https://ghost.org/" target="_blank" rel="noopener noreferrer nofollow"><strong>Ghost</strong></a>
</p>
</div>
</footer>
</footer>

0 comments on commit 108c286

Please sign in to comment.