Giter Site home page Giter Site logo

xuejie1 / book Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kaiiiz/hexo-theme-book

0.0 0.0 0.0 156 KB

[No Longer Maintained] A simple, elegant, book-like hexo theme with some useful features.

Home Page: https://kaiiiz.github.io/hexo-theme-book-demo/

License: MIT License

JavaScript 24.18% EJS 26.37% SCSS 49.45%

book's Introduction


A simple, elegant, book-like hexo theme with some useful features.

book-preview

โš  Notice

WARNING: this project is no longer maintained, and may have bugs and security issues. Feel free to fork and modify it yourself if you like it. To find the same theme maintained by other developers, check out Useful Forks.

๐Ÿ’ฟ Installation

git clone https://github.com/kaiiiz/hexo-theme-book.git themes/book

If you don't have scss renderer, follow this:

npm install hexo-renderer-scss --save

Modify theme entry in _config.yml

theme: book

Change markdown renderer

For better render quality, I suggest that you should change the default renderer.

The detail, see change markdown renderer

๐ŸŽˆ Update

Jump into the theme folder, run git pull. If you use /source/_data/book.yml, please note the diffrence of updated _config.yml.

Smooth Update

For smoothly updating, I recommand to create a config file named book.yml in /source/_data folder (If it doesn't exist, create one)

Notice: source folder is under your hexo working directory, not the theme one!

Copy the contents of /themes/book/_config.yml to /source/_data/book.yml, it will replace the contents of config in /themes/book/_config.yml. Now you can configure it independently and also, you can update theme more smoothly.

โš’ Configurations

The detail of config, see Configurations

๐ŸŽ Features

External Library Integration:

Comments system:

Others:

Code Syntax Highlight:

Using the built-in systax highlight system (highlight.js) supported from hexo itself, so no other configuration is needed.

However, there are multiple themes integrated from tomorrow-theme. You can change the theme in _config.yml.

Normal Night Night Eighties Night Blue Night Bright

Powerful and Fully-Customized Sidebar Menu:

Checkout Menu Realtime Demo

Responsive Layout:

Book will adapt to different viewpoints in order to give you the best reading experience.

book's People

Contributors

xieyuheng avatar kaiiiz 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.