Coder Social home page Coder Social logo

zhaohaijun / hexo-theme-snail Goto Github PK

View Code? Open in Web Editor NEW

This project forked from dusign/hexo-theme-snail

0.0 0.0 0.0 93.44 MB

This is a hexo theme

Home Page: https://www.dusign.net

License: Apache License 2.0

HTML 15.87% CSS 36.23% JavaScript 47.90%

hexo-theme-snail's Introduction

hexo-theme-snail

View Live Super Snail Blog →

Light theme preview

hexo-theme-snail

Dark theme preview

hexo-theme-snail

Star theme preview

hexo-theme-snail

Hexo-theme-snail is a succinct hexo theme. It has two colors, light and star, that can be set according to your own preferences in the settings, and also has the functions of sharing and commenting. More features are under development.

Features

  • light color theme and star theme
  • diversified comment system
  • notice tips
  • sharing to other platforms (under development)
  • picture sharing (under development)

Quick Start

Install Hexo

$ npm install hexo-cli -g

Setup your blog

$ hexo init blog

Installation Theme

$ cd blog
$ rm -rf source
$ rm _config.yml package.json README.md LICENSE
$ git clone https://github.com/dusign/hexo-theme-snail.git
$ mv ./hexo-theme-snail/snail ./themes
$ mv ./hexo-theme-snail/* ./
$ npm install

Install Mathjax

To install Mathjax, please click https://www.dusign.net/2019/10/14/Hexo-Configuration/ for a detailed tutorial.

Install WordCount

npm install hexo-wordcount --save

See https://github.com/willin/hexo-wordcount for detailed configuration method.

Set Theme

Modify the value of theme: in _config.yml

# Extensions
## Plugins: https://hexo.io/plugins/
## Themes: https://hexo.io/themes/
theme: snail

Start the Server

$ hexo generate
$ hexo server

Configuration

Site

Replace the following information with your own.

# Site
title: 
subtitle: At the bottom of the well, it is destined to see only the sky at the wellhead. 
          However, the starting point only affects the process of reaching your peak and does not determine the height you reach.
author: Dusign
language: en
timezone:

Site Settings

Put customized pictures in img directory.

# Site settings
SEOTitle: Hexo-theme-snail
email: [email protected]
description: "A hexo theme"
keyword: "dusign, hexo-theme-snail"
header-img: img/header_img/home-bg-1-dark.jpg
signature: true #show signature
signature-img: img/signature/dusign.png

SNS Settings

If you don't want to display it, you can delete it directly.

# SNS settings
github_username:    dusign
twitter_username:   dusignr
facebook_username:  Gang Du
zhihu_username: dusignr

Sidebar Settings

# Sidebar Settings
sidebar: true                      # whether or not using Sidebar.
sidebar-about-description: "Welcome to visit, I'm Dusign!"
sidebar-avatar: img/ironman-draw.png      # use absolute URL, seeing it's used in both `/` and `/about/`
widgets:
- search
- featured-tags
- short-about
- visitor
- recent-posts
- friends-blog
- archive
- category

# widget behavior
## Archive
archive_type: 'monthly'
show_count: true


## Featured Tags
featured-tags: true                     # whether or not using Feature-Tags
featured-condition-size: 1              # A tag will be featured if the size of it is more than this condition value


## Friends
friends: [
    {
        title: "Dusign's Blog",
        href: "https://blog.csdn.net/d_Nail"
    },{
        title: "Dusign's Web",
        href: "#"
    },{
        title: "Dusign's Github",
        href: "https://github.com/dusign"
    },{
        title: "Other",
        href: "#"
    }
]

Theme

# Extensions
## Plugins: https://hexo.io/plugins/
## Themes: https://hexo.io/themes/
theme: snail

Deployment

# Deployment
## Docs: https://hexo.io/docs/deployment.html
deploy:
  type: git
  repo:
      github: github.repository.address
      coding: coding.repository.address
  branch: master

Share

## Share
share: true

Comment

See https://github.com/imsun/gitment for detailed configuration method.

# Comment
## This comment system is gitment
## gitment url: https://github.com/imsun/gitment
comment:
  gitment:
    enable: false
    owner:
    repo:
    client_id:
    client_secret:
  livere:
    enable: false
  disqus:
    enable: false
    username:

Tip

# Tip
tip:
  enable: true
  copyright: This is copyright.
  content: false

Background effects

Set the enable value of the desired color sheme to true. If the value of bg_effects.star.enable is true, please modify the value of highlight_theme in ./themes/snail/_config.yml to night.

# Background effects
## If there is no effect after modification, please empty the cache and try again.
## ⚠️ The following special effects will take up a lot of cpu resorces, please open it carefully.
bg_effects:
  enable: true
  line:
    enable: false
    color: 129,200,61
    pointColor: 129,200,61
    opacity: 0.7
    zIndex: -9
    count: 99
  mouse_click:
    enable: true
    content: '"🌱","just do it","🍀"'
    color: '"rgb(121,93,179)"
          ,"rgb(76,180,231)"
          ,"rgb(184,90,154)"'
  wave:
    enable: true

Visitor statistics

# Visitor statistics
visitor:
  enable: true
  type: 

Color Theme

# Color Theme
## light , dark or star
## If you set the value of the `color_theme` to `dark`, set the value of the `highlight_theme` to `night` in `/theme/snail/config.yml`
## `mouse_control` is only valid for star themes
color_theme: light
mouse_control: false

Search

run $ npm install hexo-generator-search --save then add the follow configure to _config.yml

## Search
search:
  enable: true
  path: search.xml
  field: post
  content: true
  • path - file path. By default is search.xml . If the file extension is .json, the output format will be JSON. Otherwise XML format file will be exported.
  • field - the search scope you want to search, you can chose:
    • post (Default) - will only covers all the posts of your blog.
    • page - will only covers all the pages of your blog.
    • all - will covers all the posts and pages of your blog.
  • content - whether contains the whole content of each article. If false, the generated results only cover title and other meta info without mainbody. By default is true.

Error and Solutions

  • run hexo deploy with "ERROR Deployer not found: git" solution: npm install --save hexo-deployer-git

Top

Hexo-theme-snail has added the article top function, just add the following content in the article head.

top: true

Releases

v1.3

  • fix category jump path issue in sidebar
  • add a default image for new articles
  • add photography (under development)
  • fix top and page conflict

v1.2

  • fix the bug
  • add search within site
  • add top
  • image wave effect
  • add share
  • add dark theme

v1.1

  • change title font-family
  • add wordcount
  • add visitor statistics
  • fix the bug (categories not display)
  • replacing mathjax with marked

v1.0

  • fix the bugs
  • add comment system
  • add notice tips
  • add star theme
  • add line theme (background effect)
  • add mouse-click effect

License

Apache License 2.0 Copyright(c) 2018-2020 dusign
hexo-theme-snail is derived from hexo-theme-beantech ,thanks YenYuHsuan.

hexo-theme-snail's People

Contributors

dusign avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.