珠海GDG 社区文章 撰写指南
俺常常说的:
忘记的就是不重要的
不知道就是不必要的
现实往往不是这样的
可以套用在各种方面呢…
准入
~ 想理解以下内容,先明确:
习惯用最喜爱的文本编辑器编辑一切习惯Markdown习惯用E文半角标点- 承认并接受 HTML 是重要的,但是,不应该是人工编辑的
背景
对比:
- adc9cb46: 2014-08-25-snowy-blog.md - zhgdg/zhgdg - GitCafe
- e0a0abc7: 2014-08-25-snowy-blog.md - zhgdg/zhgdg - GitCafe
这是 手把手教你用git发布blog 文章的增补过程.
前一个版本, 是小言,努力了一周折腾明白基于 Jekyll 的静态Blog 网站文章怎么发布后,
写的 教程 .
后一版本,是大妈想发布为微信文章时,实在无法忍受,重构后的版本.
分析
大妈为什么无法忍受? 参考:
-
[Writing a PyCon Proposal brian curtin](http://blog.briancurtin.com/posts/writing-a-pycon-proposal.html) - pyenvな夏 in 2013 — MemoBlog
- FreeBSD unionfsの改善提案および修正状況
- 康托尔,哥德尔,图灵—永恒的金色对角线(rev#2)
- 数学常数e的含义 - 阮一峰的网络日志
- 等等,那些令人叹服的好文档吧…
在各种技术的自学过程中,大妈通过 Google 接触到了无数优良的文章/教程/文档.
他们都有共同的气质:
完备
即, 尽力将一个命题/问题的所有方面都探讨穷尽,将一篇文章写死,写到后人几乎无从增补的地步. 只是,为什么呢? 要这么累?!
后来,当大妈,也尝试写类似文章时,才发现: (How to from Jekyll jump into Pelican |蠎周刊 |汇集全球蠎事儿 !-))
正如: 学习学习再学习 - xiaolai 中指出的:
初级的知识需要对高级知识深入了解才能真正深入了解
正如以上自我相悖的图片表述的内在无限自我循环性.
每当, 我们想向大众分享体验/经验/技巧时, 因为, 受众知识水平的不可控性, 导致, 我们必须不断的在叙述过程中,持续的加入各种概念/知识点/理论/常识的阐述. 最终, 只有形成一种渐进式的,帮助情况实时出现的,引导读者跟上文字内容的反复的,螺旋式递进结构,才可能真正将想传达的事物,最大保真度的得以传达.
建议
社区官方blog 的文章,不是我们自个儿的私人笔记,是需要长期传播, 可以在任何情景任意读者面前,都可以充分的传达一个问题/命题的阐述.
所以,大妈建议,文章尽可能的应该包含以下部分:
缘起 ~ 背景历史
现象 ~ 问题描述
尝试 ~ 自个儿探索过程/思路/关键代码...
分析 ~ 将问题分析为几个关键子问题,进行逐一分析,解释
解决 ~ 最终方案的具体实施过程
要点 ~ 过程中,必须注意的操作,容易出错的地方
总结 ~ 从整体上回顾问题/解决/思路,对同类问题进行建议
参考 ~ 收集过程中各种给予自个儿有力帮助的资源/文章/代码
即,对一个命题的阐述,尽可能完备到,任何水平的人,都可以根据文章的描述,对相同的问题,独立解决.
Pelican 格式细节
除了要习惯Markdown之外, 珠海GDG 深入定制了 Pelican 完成了通常 Blog 有的各种文章功能点.
对应到每篇文章的 .md 格式中,是有约定的在此逐一说明一下
通常文章的文件名结构是:
2014-08-01-dm32-un-useless.md
| | | | | +- 统一为 md 后缀文件名
| | | | +- 文章主题内容的纯小写e文关键词
| | | | 将成为链接的一部分,不得使用中文
| | | +- 多个词使用 - 分隔
| | +- 分类文章总序号
| +- 栏目文章有固定的分类缩写
| G术图书 (gb)
| D码点评 (dd)
| G说公论 (gt)
| 珠的自白(dm)
| 海选文章(hd)
| 活动报道(et)
| 其它文章,可以自定,但是,一定要坚持统一使用
+- yyyy-mm-dd 格式日期前缀,将决定文章出现在归档中的位置
通常文章的文本结构是:
---
layout: post
title: 珠海GDG 社区文章 撰写指南
author: zoomq
categories: Doc
tags: gdg guider blog
---
引文
<!--more-->
正文
...
引文切分
<!--more--> 这是一个插件应用,
将文章切分为引文和正文,
以便网站页面只显示多篇文章的引文.
其实,是 html 标准语法的应用
头声明
每个 .md 文本头部,由两个 --- 框起来的文本,
是用来向 Pelican 系统声明文章基础信息的,
必须有,而且,有固定的格式要求
排版声明
不用修订
layout: post 含义
- 排版基于
post模板
文章标题
必须对应修订
title: 珠海GDG 社区文章 撰写指南 含义
- 文章标题是
珠海GDG 社区文章 撰写指南 - 请根据文章内容,给出一个精确概括性的标题
作者
必须对应修订
author: zoomq 含义
- 文章作者是 配置文件中
zoomq变量指代的对象 - 必须事先在
_config.yml中有相应配置的作者,在此声明才有效
以上,标题下方, Author 引导的一系列作者的私人信息对应配置是:
...
authors:
zoomq:
name: Zoom Quiet
display_name: Zoom.Quiet
gravatar: 26221c6d3cedc50c506aa699e2765252
email: [email protected]
web: http://zoomquiet.io
github: ZoomQuiet
gittip: https://www.gittip.com/ZoomQuiet/
coderwall: zoomquiet
涉及的网络个人信息服务:
- http://gravatar.com/ 头像代理
- http://github.com/ 代码社交
- https://www.gittip.com/ 私人捐助
- https://coderwall.com/ 技能徵章
分类文章
必须对应修订
categories: Doc 含义
- 文章所属分类为
Doc - 社区文章尽可能的归为固定的分类,以便在 Categories 索引中快速定位
当前固化的分类:
GdgBook G术图书
gDgcoDe D码点评
GdgTime G说公论
gDgdaMa 珠的自白
HaiDoc 海选文章
EvenTs 活动报道
Think 领域思考
Doc 社区文档
Howto 手册教程
文章标签
必须对应修订
tags: gdg guider blog 含义
- 当前文章的标签是:
- gdg
- guider
- blog
参考:
所以,大妈建议:
- tag 至少3个,最多5个
- 不用中文
- 尽可能从文章的多种维度进行标签
- 通常的维度:
- 分类
- 文章性质
- 作者
- 内容层次
- 领域范畴
修订记录
- 140911 惊情完成
- 140910 为小言的发布指南增补专门说明
参考
巡阅
- 150113 Zoom.Quiet checked
声明: 本文采用 BY-NC-SA 授权。转载请注明转自: #ZHGDG#
以上...
加入 珠海GDG
- 注册 Meetup
- 关注 Zhuhai GDG
- 或扫描:
通过 珠海GDG 可以:
第一时间获知谷歌最新技术,
可以学到如何去谷歌平台上赚钱的思路和方法,
可以认识很多有可能将来一起走上自己创业道路的人,
可以学会把你的创新带向国际市场,
参加那里的活动有经常和国际上的开发者们进行交流的机会...
PS:
若无意外,题图都是从原文提取或是通过 Google 图片搜索出来的, 版权属左, 不负责任 ;-)
PPS:
珠海GDG 微信/Blog 欢迎投稿,只要追自认内容吻合以下条件:
0. 有趣 ~ 至少是自个儿有兴趣的领域吧... 1. 有料 ~ 至少有点儿原创的东西吧.. 2. 有种 ~ 至少不能是成功学吧!
有好物请及时通过邮件列表投稿成也:
[email protected]
(发空邮件到 [email protected] 即完成订阅)
微信公号
栏目设定:
G术图书 (gb:推荐好书,书无中外)
D码点评 (dd:麻辣评点,善意满盈)
G说公论 (gt:时评杂文,新旧不拘)
珠的自白(dm:大妈自述,每周一篇)
海选文章(hd:得要相信,大妈法眼)
总之, 请大家告诉大家, 珠海生活中的技术社区 都来订阅呗 ;-)
订阅方法
- 搜索微信号
GDG-ZhuHai - 或查找公众号:
GDG珠海 - 或扫描:
GDG珠海 社区资源:
- 邮件列表: [email protected] (可发空邮件到 [email protected] 即完成订阅)
- 微信: GDG珠海
- 博客: 珠海GDG | GDG Livin ZhuHai Life;-)
大妈的多重宇宙 - YouTube
全新自媒体系列...科学幻想,读书,说故事...任何问题
随时邮件提问可也:[email protected]
