Giter Club home page Giter Club logo

maupassant-hexo's Introduction

Maupassant

Build Status GitHub license

大道至简

Preview中文文档

A simple Hexo template with great performance on different devices, ported from a Typecho theme by Cho, forked and modified from icylogic.

template preview

Installation

Install theme and renderers:

git clone https://github.com/tufu9441/maupassant-hexo.git themes/maupassant
npm install hexo-renderer-sass --save
npm install hexo-renderer-jade --save

Then change your theme setting in _config.yml to maupassant.

Configuration

Default config:

fancybox: true ## If you want to use fancybox please set the value to true
duoshuo: ## Your duoshuo_shortname, e.g. haomwei
disqus: ## Your disqus_shortname, e.g. haomwei
google_search: true ## Use Google search, true/false
baidu_search: ## Use Baidu search, true/false
swiftype: ## Your swiftype_key, e.g. m7b11ZrsT8Me7gzApciT
tinysou: ## Your tinysou_key, e.g. 4ac092ad8d749fdc6293
google_analytics: ## Your Google Analytics tracking id, e.g. UA-42425684-2
baidu_analytics: ## Your Baidu Analytics tracking id, e.g. 8006843039519956000

menu:
  - page: home
    directory: .
    icon: icon-home
  - page: archive
    directory: archives/
    icon: icon-archive
  - page: about
    directory: about/
    icon: icon-about
  - page: rss
    directory: atom.xml
    icon: icon-rss
    
widgets: ## Six widgets in sidebar provided: search, category, tag, recent_posts, rencent_comments and links.
  - search
  - category
  - tag
  - recent_posts
  - recent_comments
  - links
  
links:
  - title: site-name1
    url: http://www.example1.com/
  - title: site-name2
    url: http://www.example2.com/
  - title: site-name3
    url: http://www.example3.com/
  • fancybox - Enable Fancybox
  • duoshuo - Duoshuo shortname
  • disqus - Disqus shortname
  • google_search - Default search engine
  • baidu_search - Search engine for users in China
  • swiftype - Swiftype Search key
  • tinysou - Tiny Search key
  • google_analytics - Google Analytics tracking id
  • baidu_analytics - Baidu Analytics tracking id
  • menu - Customize your menu of pages here, just follow the format of existied items. IcoMoon icon fonts have been integrated, and you can choose other icons you like here and use them according to the instruction
  • widgets - Choose and arrange the widgets in sidebar here
  • links - Edit your blogroll here

##Features

Logo

You can set a favicon.ico for your website, please put it into source folder of hexo directory, recommended size: 32px*32px.

You can add a website logo for apple devices, please put an image named apple-touch-icon.png into source folder of hexo directory, recommended size: 114px*114px.

Abstract

You can control the abstract of a post shown at index, by either filling a description: item in front-matter of the post.md, or just inserting a <!--more--> before your hidden content.

Table of Contents

TOC in a post can be enabled by adding a toc: true item in front-matter.

Comments

Comment feature of each post and page can be enabled (default) and disabled by adding a comments: true or comments: false in front-matter. This could be useful when you want comment feature for guestbook page, but don't want comment feature for about page.

Syntax Highlighting

Highlighted code showcase is supported, please set the highlight option in _config.yml of hexo directory like this:

highlight:
  enable: true
  auto_detect: true
  line_number: true
  tab_replace:

Languages

Four languages are available for this theme currently: Simplified Chinese (zh-CN), Traditional Chinese (zh-TW), English (en) and Spanish (es-ES). Contributions of translating to other languages will be highly appreciated.

Solutions

  • Check whether your Terminal's current directory is in hexo's root directory which contains source/, themes/, etc.

  • If you have any trouble in using this theme, please feel free to open an issue.

Contributing

All kinds of contributions (enhancements, new features, documentation & code improvements, issues & bugs reporting) are welcome.

Looking forward to your pull request.

Acknowledgements

Thank JamesPan for his help to improve this theme .

Maupassant on other platforms:

maupassant-hexo's People

Contributors

tufu9441 avatar icylogic avatar v123582 avatar sabrinaluo avatar abandonzhang avatar fermion42 avatar okelet avatar 7ffe avatar suiteki avatar jvalen avatar nfs1a avatar

Watchers

James Cloos avatar  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.