Git Product home page Git Product logo

canoe-blog's Introduction

hugo-YAMT-theme

Yet Another Material Theme for hugo. demo.

Feature

  1. Waterfall layout
  2. Responsive layout
  3. Material design
  4. Table of content
  5. Tiny and powerfull, no JQuery
  6. Chinese keyword search(using lunr and nodejieba)

How to use or dev

This theme is writted by typescript and sass and using gulp to control the build progress.

First, install hugo and make sure you have a node environment.
Next, clone this repo and replace my stuff (such as post,pages,link,etc...) with yours.
Then, install the node dependencies with yarn or npm:

  # install glob globally
  yarn global add gulp # or npm install gulp -g
  # install dependencies
  yarn install # or npm install

Finally, there are several gulp tasks we can run in the terminal:

  1. gulp serve: start a livereload dev server. equivalent to hugo serve.
  2. gulp build: generate static file to your publish dir. equivalent to hugo.
  3. gulp lunr: generate a lunr-index-json file (with Chinese support) to your publish directory.

After using guilp build,the static pages should be generated into docs folder, all the static resources should be minified and revisioned.

Finally, push the whole project to your github repo, and enable the github pages with the help of offical docs your site should be published soon.

canoe-blog's People

Contributors

enter-tainer avatar stkevintan 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.