Giter Club home page Giter Club logo

silentor's Introduction

silentor's People

Contributors

jayin avatar jianzhiyao avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

silentor's Issues

提供一个常量__IMG__来更好地处理图片链接

图片路径./img/不够友好

用户可能认为./img/表示当前目录下上的img/文件夹,实际上,逻辑目录上没有

例如

---blog
      |---img
          |---test.png
      |---p
           |---linux
              |---test1.md
              |---test2.md
           |---ruby  

用户在写test2.md这文章的时候,图片引用写成![title](./img/test.png),这样用户会认为当前目录(linux/)下有个img文件夹用户存放文件

实际上,我们约定图片都存放在{app_name}/img/

更详细的教程

  1. fork后怎么修改
  2. clone后怎么修改
  3. github-pages的一些概念(为何会有app_name)

[New Feature]在本文引用其他目录的文章

需求

我正在浏览~?notes/linux/install-Java.md linux下安装java,但是我文中提到如果你想安装XX请看之前的YY文章这时候,我们就会弄个链接上去,但是问题来了,目前版本的silentor只能实现链接到统一目录下的文件

也就是只能链接到~?notes/linux/*.md

如果想链接到~?notes/python/1.md or ~?tech/php/*.md呢?

效果

  1. 当前目录: [1.md] or [./1.md] (后者不推荐这样写,但是可以这样写)
  2. 上一目录: [../ruby/1.md] (不推荐这样写,但是你也可以这样写)
  3. 再上一目录? 别开玩笑../../ruby/1.md这样太难看了,拒绝这样写!
  4. 推荐添加一个跟目录常量__ROOT__,表示这是文章目录p/的位置,那么你像引用那一块就那一块。eg:[linux下配置java](__ROOT__/notes/linux/install-java.md)

支持多个相对路径

#1 中讨论

再上一目录? 别开玩笑../../ruby/1.md这样太难看了,拒绝这样写!

相对路径可以

  • 能github中浏览
  • 在一些编辑器中可以预览图片(Mou)

侧栏加入box-shadow

box-shadow:0 4px 5px 0 rgba(0,0,0,.14),0 1px 10px 0 rgba(0,0,0,.12),0 2px 4px -1px rgba(0,0,0,.2)

v2.0.0 Roadmap

  • cli 支持
  • 插件与silentor分离?(目前都混在一起)
  • 自动build?
  • rss

Hooks

有时候我们需要根据用户的特定需求,可能需要定制一下silentor,提供一些hooks便于定制开发,而不是改源代码.

例如: 用户加载完main-page 的内容后(主页有可能是索引页,因而不显示评论),需要决定是否显示评论框.

Hooks

  • sidebar-page
    • 加载sidebar-page前 before-load-sidebar-page
    • 加载sidebar-page后 loaded-sidebar-page
  • main-page
    • 加载main-page 前 before-load-main-page
    • 加载main-page 后 loaded-main-page
  • main-page-footer
    • 加载main-page-footer前 before-load-main-page-footer
    • 加载main-page-footer后 loaded-main-page-footer
  • 找不到404 page-not-found, 额外传入的data:
    • data.selector 要加载的selector
    • data.path: md路径(加载页路径)

Usage

src/extension/pluginName/main.js

;(function($) {
    'use strict';
    $(window).on('loaded-sidebar-page', function() {
       // console.log('loaded-sidebar-page')
    });
    $(window).on('loaded-main-page', function() {
      // your code
    });
    $(window).on('loaded-main-page-footer', function() {
        // console.log('loaded-main-page-footer')
    });

    $(window).on('page-not-found', function(evt, data){
        // console.log('page-not-found')
    });

    $(window).on('before-load-sidebar-page', function(evt, data){
        // console.log('before-load-sidebar-page')
    });
    $(window).on('before-load-main-page', function(evt, data){
        // console.log('before-load-main-page')
    });
    $(window).on('before-load-main-page-footer', function(evt, data){
        // console.log('before-load-main-page-footer')
    });
    //。。。。。。
})(jQuery);

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.