美文网首页
实习之Markdown

实习之Markdown

作者: Sisyphus235 | 来源:发表于2017-12-31 12:01 被阅读0次

    1. 引言

    computer engineering的领域有非常多的技术,很多人都会感慨:即使每天都在努力学习新技能,也只能勉强跟上自己技术领域的新技能。

    比如今年火起来的HTML5,大范围替代了flash。



    又比如经典的网站开发技术迭代,从纯HTML静态网页,到asp.net等动态网页,再到Django等网络开发框架。



    客观的技术爆炸让简单粗暴的学习变得越来越困难,所以在学习之前,思考学习什么变成了新的挑战。如果只是努力学习技术,算不上勤奋,再加上思考学习什么,才能走出自己的道路,在行业中往往思考者很稀缺。

    2. 日常技能

    作为一个转型的新人,真正实习时,我才能看到技术的广袤。就像一个内陆的人,只有站到大海旁,才能感受到自己的渺小。

    在信息时代,最不缺的就是信息技术,无论是人们的兴趣还是市场的调节,都在计算机产业催生出大量技术。从网站开发,到APP开发,再到机器学习,无数领域就像地图上的城镇村落被先人们开发出来,而在鳞次栉比的建筑外,是更加广阔未被探索的技术荒漠。

    最开始时我每天都在查询技术名词,比如耳熟能详的URL和API到底代表什么含义,只是简单的知道定义的范围无法满足技术沟通的需要。深入了解才知道URL是uniform resource locator的缩写,它的语境是在网络上资源的位置符,并集成了获得资源的方法;API是application programming interface的缩写,代表一个应用程序所包含的定义、协议和方法,它的作用是沟通不同的应用程序。


    像这样的收获每天都有很多,清楚每个定义的深层含义,才能高效的沟通和工作,比如上述的API,如果语境中我的任务要开发API,那就意味着核心任务是建立一套接口能够高效的对接其他程序。在后续文章中,也许我会从一个新人的角度,专门找一篇来讲讲工作中我所遇到的重要专有名词。

    3. Markdown

    3.1 why markdown

    工作伊始,往往一个新人是无法未团队创造价值的,更多的时候是反向的在吃团队的资源。换句话说,当一个新人对环境不熟悉的时候,不仅无法发挥自己的专业技能,而且需要占用团队中他人的时间来帮助你熟悉环境。

    破局的关键是找到团队需要的资源,结合自己的能力,尽快做出贡献。在公司搭建一个陌生的环境,显然我无法在新环境上快速发力,但是每一个公司入职者都有一个刚需——搭建环境,所以写一篇markdown文档梳理搭建环境的流程就是一种很好的贡献方式。

    3.2 markdown grammar

    markdown给我的感觉是随着github一同火起来的工具,对文本记录的需求古而有之,但是网络的出现使得沟通之间存在障碍。markdown的语法使得其本身就可以被阅读,这种理念与git的版本控制不谋而合,都是给予人们更加自由办公的一种工具,git解放了开发的版本问题,markdown解放了文本的阅读问题。

    工作中最常使用的markdown grammar如下:
    (1)标题
    文字前面有几个“#”,就是几级标题

    # 一级标题
    ## 二级标题
    

    (2)换行
    文本中的换行在编译时会被删除,浏览器一般根据可用空间自动调整换行。

    强制换行的话在行尾插入两个空格,这在网页内嵌的markdwon编辑器中极其有用。
    如果依然无法换行,另一个小技巧是在行尾输入两次回车

    (3)引用
    像很多影视作品有画外音一样,markdown提供了方便的引用标记:

    > 引用内容,这段内容会被作为HTML的引用元素
    上段内容会被转换为
    <blockquote><p>引用内容,这段内容会被作为HTML的引用元素</p></blockquote>
    

    (4)编码
    就像这篇markdown上述内容展示一样,很多时候工作中需要展示编码的情况,不想要被转换。使用的方法是:

    ` 编码内容`
    注意,不同markdown的转换器规则不同,比如简书平台规定```为编码内容。
    

    markdwon的转换规则不同平台不一样,工作中在编码的时候,建议编码符单独成行,以避免不必要的bug,例如:
    `
    编码内容
    `

    (5)转译符号
    和很多编程语言一样,""有转译功能。

    (6)超链接图片/文档
    比如github上的wiki,如果想要在一篇markdown引用另一篇编辑好的markdown,方法是:

    图片引用的方法是:! [被引用图片名称] (被引用图片URL)
    wiki引用的方法是:[当前文档显示名称](被引用文档名称)
    

    详细的markdown语法:markdwon grammar

    4. 收获

    虽然computer engineering中的技术异常丰富,但是日常高频的技术总是容易发现的,先打好基础,做好大本营,再派出哨兵探索不同路径的可能,进而决定自己的专长或许是一种方法。
    上述的markdown就是一种万金油技能,几乎任何团队都需要,且好的文档能够大大提升团队的工作效率,这也是github上wiki被看重的原因之一。

    相关文章

      网友评论

          本文标题:实习之Markdown

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