美文网首页
SuperDo博客格式规范

SuperDo博客格式规范

作者: babybus_superdo | 来源:发表于2016-04-28 18:03 被阅读115次

我们统一使用markdown来编写博客。使用markdown编写,我们一起遵循一些规则吧。

1、遵循的几个规则

  • 新建文章介绍

    • 登录博客后,点击右上角的头像,在下拉列表中选择【写文章】,即可开始编写文章。如图所示:


      图1.png
    • 写文章时,如果需要创建新的类名,可以点击左边的【新建文集】来创建新的文集。如图所示:


      图2.png
    • 好用的【切换到预览模式】。写文章时,可以点击【切换到预览模式】,这样使用markdown的语法编写博客时,可以做到所见即所得,写博客更方便。如图所示:


      图3.png

      切换到预览模式的效果图:


      图4.png
  • 文集命名规则
    我们统一使用简洁短小的命名规则。如果是中文,建议不要超过四个字,如果是英文,建议不要超过两个单词。

  • 标题栏规则

    ##1、一级标题
      * **二级标题**
       * 三级标题
    
    ##2、一级标题
      * **二级标题**
        * 三级标题
    

    我们标题统一按上面的模板来设计,标题一般三级就够用了。上面的标题显示效果如下:

    1、一级标题

    • 二级标题
      • 三级标题

    2、一级标题

    • 二级标题
      • 三级标题
  • 提示栏规则
    有的时候,提示栏会让人印象深刻,提示栏的写法:
    > 我是提示栏
    显示效果:

我是提示栏

可以参看Vysor:一款连接Android设备和Chrome的神奇工具!来看下提示栏的写法。

  • 字体加粗
    有的时候你需要字体加粗,可以用两个星号包裹住要加粗的文字,写法如下写法如下:
    字体普通字体加粗字体普通
    显示效果:
    字体普通字体加粗字体普通
  • 字体倾斜
    有的时候你需要字体倾斜,可以用两个下划线包裹住要倾斜的文字,写法如下:
    字体普通字体倾斜字体普通
    显示效果:
    字体普通字体倾斜字体普通
  • 黏贴代码
    有的时候我们需要在博客里黏贴代码,代码的写法如下,可以在代码的两端用```来包裹:
  /** 打开类型 **/
  public class AdOpenType {
    
      public static final int OPENTYPE_BABYBUS = 1;
      public static final int OPENTYPE_THIRD = 2;
      public static final int OPENTYPE_UMENG = 3;
      public static final int OPENTYPE_PAGE = 4;
      public static final int OPENTYPE_PHONE = 5;
      public static final int OPENTYPE_VIDEO = 6;
      public static final int OPENTYPE_SOUND = 7;
      public static final int OPENTYPE_MAP = 8;
  }


显示效果:

    /** 打开类型 **/
    public class AdOpenType {
      
        public static final int OPENTYPE_BABYBUS = 1;
        public static final int OPENTYPE_THIRD = 2;
        public static final int OPENTYPE_UMENG = 3;
        public static final int OPENTYPE_PAGE = 4;
        public static final int OPENTYPE_PHONE = 5;
        public static final int OPENTYPE_VIDEO = 6;
        public static final int OPENTYPE_SOUND = 7;
        public static final int OPENTYPE_MAP = 8;
    }

如果你的代码就一句,你也可以连续缩进3个tab来展示代码。写法如下:
【在此缩进三个tab】echo "***** 开始生成java_project.zip *****......"
显示效果:
echo "***** 开始生成java_project.zip *****......"

  • 博客结尾作者版权说明规范
    我们在博客结束后,要有版权说明描述。写法如下:
--------------------

_本站文章为**[ 宝宝巴士 SD.Team ](http://www.cnblogs.com/superdo)**原创,转载务必在明显处注明:(作者官方网站:[ 宝宝巴士 ](http://www.babybus.com/)) _
_转载自**[【宝宝巴士SuperDo团队】](http://blog.babybus.com)**原文链接: [http://www.jianshu.com/p/06eaace83962](http://www.jianshu.com/p/06eaace83962)_

显示效果:

图5.png

2、总结

以上就是我们SuperDo的博客格式规范,有问题和补充的欢迎说明,我们会改进这个规则的。


_本站文章为 宝宝巴士 SD.Team 原创,转载务必在明显处注明:(作者官方网站: 宝宝巴士 ) _
转载自【宝宝巴士SuperDo团队】原文链接: http://www.jianshu.com/p/cc0093d17710

相关文章

网友评论

      本文标题:SuperDo博客格式规范

      本文链接:https://www.haomeiwen.com/subject/gmchrttx.html