GithubHelp home page GithubHelp logo

szmer / edidor Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sfengyuan/edidor

0.0 0.0 0.0 2.26 MB

A hugo theme that looks like an editor with a builtin style generator, INFINITE COLOR MODE from a market perspective. πŸ˜‚

Home Page: https://ziox.xyz/

License: MIT License

HTML 29.72% CSS 35.12% JavaScript 35.17%

edidor's Introduction

Edidor

δΈ­ζ–‡

A hugo theme that looks like an editor with a builtin style generator, INFINITE COLOR MODE from a market perspective. πŸ˜‚

Thanks for @GoHugoIO's promotion

Screenshot

This is the light mode. screenshot This is the dark mode. screenshot

Now this is the interesting part -- wild mode. screenshot Wild mode too. screenshot Still wild mode. screenshot

Wild Mode Demo

I don't need to post more images, you can generate it by your self. Just head to my site. Keep clicking 'Theme > Wild mode'

No guarantee for what colors you can get πŸ™ƒ

Features

  • viewport unit, test from 1920 x 1080 desktop to 320 x 568 mobile
  • No frameworks, only a Lodash throttle and an easing function from d3.ease
  • All static icons are inline svgs, coloring available due to mask-image
  • syntax hightlighting by highlight.js, can be turn off
  • Disqus comment system
  • multiple languages

i18n isn't completed!! NO IE support, and does in future!

Installation

Inside the folder of your Hugo site run:

cd themes
git submodule add https://github.com/jacobsun/edidor

Or

cd themes
git clone https://github.com/jacobsun/edidor

Usage

Copy config.toml in exampleSite to your site root folder, you are good to go, you can also find more information there.

Config

Logo

Logo images should be svg file, they are in the root/static/images/ directory. You need to have three versions. Just copy and rename theme, if you don't want to use separate design.

  • logo.svg(default in dark mode!)
  • logo_light.svg
  • logo_wild.svg

The theme will display the appropriate logo automatically.

Menu

Some menu entries are important to the theme, if you change it, some functions will stop to work.

Do not change these fields:

  • the name of 'Theme'
  • all 'identifier' shipped with the theme.

Beyond those, you can customize it as you like.

Why the field 'Theme' in menu doesn't use identifier, but name?

I tried, but when I add an identifier to the top menu, some weired things happend, this is just a temporary workaroud.

Wild mode

This is my favourite, and here is how it works. When you click the 'wild mode' link, some random css color rules will be applied to the page, and also saved in your browser's localStorage. When you go to another page, thoese rules will be loaded from local machine and applied again.

If you want to publish the local styles to your server end. You have to use custom css in hugo.

Custom CSS

In your config file: add

[params]
    customCss = ["custom.css", ...]

Place the custom.css to your site root/static/css directory.

Add wild mode CSS

Click Export Wild mode, and enter a theme name, a css file will be downloaded. You can find the code that you need in this file, and following the above steps.

Custom JS

In your config file: add

[params]
    customJs = ["custom.js", ...]

Place the custom.js to your site root/static/js directory.

Custom syntax highlighting

The theme use hightlight.js library, if you want to use custom hightlight.js, add it as custom js, and add this to your config.

useCustomSyntaxHighlight = true

You don't need to run the code manually.

Todo

Other

This is a new theme, if you found any problems, feel free to open an issue, and contribution is welcome! 😊

FAQ

License

MIT

edidor's People

Contributors

sfengyuan avatar szmer avatar dependabot[bot] avatar

edidor's Issues

weird behavior of the background logo/container size

There is a background logo in this theme that appears when loading a page. This is often jarring.

The main problem is that after resizing the container (eg. when calling up the Commento login), the container remains in an incorrect state, showing some of the background logo and hiding content. This cannot be fixed besides reloading the page.

autofocus on the content column

It would be nice to autofocus the page on the content column (right), so the arrow keys would work immediately for scrolling.

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.