blog/README.md

[curben.netlify.com](https://curben.netlify.com/)
===

[![Netlify Status](https://api.netlify.com/api/v1/badges/aaf73659-db84-4c41-a700-de3926022674/deploy-status)](https://app.netlify.com/sites/curben/deploys)
[![Build Status](https://gitlab.com/curben/curben.gitlab.io/badges/master/pipeline.svg)](https://gitlab.com/curben/blog/-/jobs)
[![Hexo version](https://img.shields.io/badge/hexo-3.9.0-brightgreen.svg)](https://www.npmjs.com/package/hexo)

Forked from GitLab's [Hexo](https://gitlab.com/pages/hexo) example with [Typing](https://github.com/geekplux/hexo-theme-typing) theme.

## Installation

Refer to [this post](https://curben.netlify.com/2018/09/21/how-to-create-a-hexo-blog/) for more detailed instruction.


### Plugins
- Installed [hexo-nofollow](https://github.com/curbengh/hexo-nofollow) for SEO purpose to prevent search engines from following external links.
- Installed [hexo-yam](https://github.com/curbengh/hexo-yam) to pre-compress static assets (html, css, js and svg).
- [copy-button.js](/scripts/copy-button.js) - A [filter](https://hexo.io/api/filter) plugin to add a copy button to each code block.
- [feed](/scripts/feed) - A generator plugin to generate [an RSS feed](https://en.wikipedia.org/wiki/Web_feed). Modified from [hexo-generator-feed](https://github.com/hexojs/hexo-generator-feed) to use `post.lastUpdated` instead of `post.updated`.
- [heading-link.js](/scripts/heading-link.js) - A filter plugin to add a link button next to each heading.
- [image.js](/scripts/image.js) - A [tag](https://hexo.io/api/tag) plugin to easily embed images in a post with responsive image support.
- [link.js](/scripts/link.js) - A [helper](https://hexo.io/api/helper) plugin to add a link. Modified from [link_to.js](https://github.com/hexojs/hexo/blob/master/lib/plugins/helper/link_to.js) to remove title attribute and 'external' option.
- [openGraph](/scripts/openGraph.js) - A helper plugin to add [Open Graph](https://ogp.me/) tags. Modified from [open_graph.js](https://github.com/hexojs/hexo/blob/master/lib/plugins/helper/open_graph.js) to use additional [Open Graph](https://www.ogp.me/) tags and [WHATWG URL API](https://nodejs.org/api/url.html#url_the_whatwg_url_api).
- [sitemap](/scripts/sitemap) - A [generator](https://hexo.io/api/generator) plugin to generate [a sitemap](https://en.wikipedia.org/wiki/Sitemaps). Modified from [hexo-generator-sitemap](https://github.com/hexojs/hexo-generator-sitemap) with this [patch](https://github.com/hexojs/hexo-generator-sitemap/pull/26) to include tags/categories and [remove](https://github.com/pyyzcwg2833/hexo-generator-sitemap/commit/a92dbbb83cc39ff60d43faa5cd688a56574a3889) [index.html](https://github.com/hexojs/hexo-generator-sitemap/pull/59) from the URL.

## Changes
The following are the major changes I made compared to the upstream.

### [Hexo](https://gitlab.com/pages/hexo) site
- Updated [.gitlab-ci.yml](.gitlab-ci.yml) to use the latest version of [Node.js](https://hub.docker.com/_/node/) in Alpine docker image.
- [All packages](package.json) are installed from their respective master branch, instead of npm published version.
- Removed unused packages, [hexo-generator-category](https://github.com/hexojs/hexo-generator-category) and [hexo-renderer-stylus](https://github.com/hexojs/hexo-renderer-stylus) from the [default packages](https://github.com/hexojs/hexo-starter/blob/571320ba41a83e065d7560e050eb3fa63ad74a57/package.json#L9-L17).
- Replaced the bundled Landscape theme with Typing theme.
- Add `lastUpdated` to the front-matter to manually set updated time of a post, instead of using `post.updated`.

### [Chameleon theme](/themes/chameleon)
Chameleon is a fork of [Typing](https://github.com/geekplux/hexo-theme-typing) theme, rewrote from scratch with the following changes/features:

- [sanitize.css](https://github.com/csstools/sanitize.css/) and [autoprefixer](https://github.com/csstools/sanitize.css/) for consistent cross-browser styling.
- Utilise [relative length](https://www.w3schools.com/CSSref/css_units.asp) instead of absolute length in the css.
- [`prefers-color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) to apply light/dark theme according to the OS preference.
- Add a [Copy](https://clipboardjs.com/) button to each code block.
- Removed jQuery, fancyBox, web analytics, comment plugins, donation links and [typo.css](https://github.com/sofish/typo.css).
- Homepage shows index of posts (same as /archives).

## License
The content of this blog is licensed under the [CC-BY-SA license](https://creativecommons.org/licenses/by-sa/4.0/), and the underlying source code used to format and display that content is licensed under the [MIT license](LICENSE.md), unless indicated otherwise.

---
Useful links:

- [Hexo Docs](https://hexo.io/docs/)
- [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/index.html)
Update changes to readme 2018-10-25 04:37:04 +00:00			`[curben.netlify.com](https://curben.netlify.com/)`
			`===`
Update README 2018-09-18 11:32:30 +00:00
docs: add Netlify deploy status badge https://www.netlify.com/blog/2019/01/29/sharing-the-love-with-netlify-deployment-badges/ 2019-04-12 03:53:45 +00:00			`[![Netlify Status](https://api.netlify.com/api/v1/badges/aaf73659-db84-4c41-a700-de3926022674/deploy-status)](https://app.netlify.com/sites/curben/deploys)`
docs: fix links in badge 2019-05-13 06:25:02 +00:00			`[![Build Status](https://gitlab.com/curben/curben.gitlab.io/badges/master/pipeline.svg)](https://gitlab.com/curben/blog/-/jobs)`
docs(readme): hexo 3.9.0 badge 2019-06-22 05:22:40 +00:00			`[![Hexo version](https://img.shields.io/badge/hexo-3.9.0-brightgreen.svg)](https://www.npmjs.com/package/hexo)`
Update README 2016-04-05 15:03:17 +00:00
Create installation guide 2018-09-20 10:18:13 +00:00			`Forked from GitLab's [Hexo](https://gitlab.com/pages/hexo) example with [Typing](https://github.com/geekplux/hexo-theme-typing) theme.`
Update README 2018-09-19 06:13:34 +00:00
Create installation guide post Move the lengthy installation guide to a new blog post. 2018-09-21 04:39:51 +00:00			`## Installation`

docs(readme): remove install/usage guide 2019-08-11 18:32:43 +00:00			`Refer to [this post](https://curben.netlify.com/2018/09/21/how-to-create-a-hexo-blog/) for more detailed instruction.`
docs: update nodejs installation instruction * in readme, add instruction to install more updated nodejs * in readme, add a link to the relevant post for more detailed instruction * in posts, append 'or newer' to fedora, now that fedora v30 is released * in posts, add '--only=prod' parameter to skip devDeps 2019-05-18 05:19:46 +00:00
Update README 2018-09-18 11:32:30 +00:00
docs: rename typing to chameleon theme 2019-09-11 05:51:23 +00:00			`### Plugins`
			`- Installed [hexo-nofollow](https://github.com/curbengh/hexo-nofollow) for SEO purpose to prevent search engines from following external links.`
			`- Installed [hexo-yam](https://github.com/curbengh/hexo-yam) to pre-compress static assets (html, css, js and svg).`
			`- [copy-button.js](/scripts/copy-button.js) - A [filter](https://hexo.io/api/filter) plugin to add a copy button to each code block.`
			- [feed](/scripts/feed) - A generator plugin to generate [an RSS feed](https://en.wikipedia.org/wiki/Web_feed). Modified from [hexo-generator-feed](https://github.com/hexojs/hexo-generator-feed) to use `post.lastUpdated` instead of `post.updated`.
			`- [heading-link.js](/scripts/heading-link.js) - A filter plugin to add a link button next to each heading.`
			`- [image.js](/scripts/image.js) - A [tag](https://hexo.io/api/tag) plugin to easily embed images in a post with responsive image support.`
			`- [link.js](/scripts/link.js) - A [helper](https://hexo.io/api/helper) plugin to add a link. Modified from [link_to.js](https://github.com/hexojs/hexo/blob/master/lib/plugins/helper/link_to.js) to remove title attribute and 'external' option.`
			`- [openGraph](/scripts/openGraph.js) - A helper plugin to add [Open Graph](https://ogp.me/) tags. Modified from [open_graph.js](https://github.com/hexojs/hexo/blob/master/lib/plugins/helper/open_graph.js) to use additional [Open Graph](https://www.ogp.me/) tags and [WHATWG URL API](https://nodejs.org/api/url.html#url_the_whatwg_url_api).`
			- [sitemap](/scripts/sitemap) - A [generator](https://hexo.io/api/generator) plugin to generate [a sitemap](https://en.wikipedia.org/wiki/Sitemaps). Modified from [hexo-generator-sitemap](https://github.com/hexojs/hexo-generator-sitemap) with this [patch](https://github.com/hexojs/hexo-generator-sitemap/pull/26) to include tags/categories and [remove](https://github.com/pyyzcwg2833/hexo-generator-sitemap/commit/a92dbbb83cc39ff60d43faa5cd688a56574a3889) [index.html](https://github.com/hexojs/hexo-generator-sitemap/pull/59) from the URL.

Create installation guide 2018-09-20 10:18:13 +00:00			`## Changes`
Update changes to readme 2018-10-25 04:37:04 +00:00			`The following are the major changes I made compared to the upstream.`
Create installation guide post Move the lengthy installation guide to a new blog post. 2018-09-21 04:39:51 +00:00
Update changes to readme 2018-10-25 04:37:04 +00:00			`### [Hexo](https://gitlab.com/pages/hexo) site`
docs(readme): grammar 2019-08-11 18:51:34 +00:00			`- Updated [.gitlab-ci.yml](.gitlab-ci.yml) to use the latest version of [Node.js](https://hub.docker.com/_/node/) in Alpine docker image.`
docs(readme): merge section 2019-08-11 18:49:24 +00:00			`- [All packages](package.json) are installed from their respective master branch, instead of npm published version.`
			`- Removed unused packages, [hexo-generator-category](https://github.com/hexojs/hexo-generator-category) and [hexo-renderer-stylus](https://github.com/hexojs/hexo-renderer-stylus) from the [default packages](https://github.com/hexojs/hexo-starter/blob/571320ba41a83e065d7560e050eb3fa63ad74a57/package.json#L9-L17).`
docs(readme): grammar 2019-08-11 18:51:34 +00:00			`- Replaced the bundled Landscape theme with Typing theme.`
docs(readme): mention lastUpdated 2019-08-19 00:51:18 +00:00			- Add `lastUpdated` to the front-matter to manually set updated time of a post, instead of using `post.updated`.
Update README 2018-09-18 11:32:30 +00:00
docs: rename typing to chameleon theme 2019-09-11 05:51:23 +00:00			`### [Chameleon theme](/themes/chameleon)`
docs: add readme to theme 2019-09-15 18:09:38 +00:00			`Chameleon is a fork of [Typing](https://github.com/geekplux/hexo-theme-typing) theme, rewrote from scratch with the following changes/features:`
Update README 2016-04-05 15:03:17 +00:00
docs: rename typing to chameleon theme 2019-09-11 05:51:23 +00:00			`- [sanitize.css](https://github.com/csstools/sanitize.css/) and [autoprefixer](https://github.com/csstools/sanitize.css/) for consistent cross-browser styling.`
			`- Utilise [relative length](https://www.w3schools.com/CSSref/css_units.asp) instead of absolute length in the css.`
			- [`prefers-color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) to apply light/dark theme according to the OS preference.
			`- Add a [Copy](https://clipboardjs.com/) button to each code block.`
			`- Removed jQuery, fancyBox, web analytics, comment plugins, donation links and [typo.css](https://github.com/sofish/typo.css).`
			`- Homepage shows index of posts (same as /archives).`
Add license 2018-10-25 04:20:01 +00:00
			`## License`
docs(readme): add license disclaimer and shorten CC 2019-06-12 08:30:35 +00:00			`The content of this blog is licensed under the [CC-BY-SA license](https://creativecommons.org/licenses/by-sa/4.0/), and the underlying source code used to format and display that content is licensed under the [MIT license](LICENSE.md), unless indicated otherwise.`
Add license 2018-10-25 04:20:01 +00:00
Create installation guide 2018-09-20 10:18:13 +00:00			`---`
			`Useful links:`
Fix links formatting 2018-10-25 04:24:27 +00:00
			`- [Hexo Docs](https://hexo.io/docs/)`
			`- [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/index.html)`
Use mobile-friendly favicon https://realfavicongenerator.net/ Undo e3b6dc8404cda5a96f64b8392b1971139180802b 2018-09-20 04:11:03 +00:00