Markdown

如何写出一篇高质量的技术分享文档

核能气质少年 提交于 2021-01-02 06:27:25
自己也写技术分享文章,也经常看别人的分享文章,本篇就简单梳理梳理个人的一些看法,希望能给一些准备写技术分享的同学一点帮助。 优先确定技术文章面向的受众 。 是初级、中级还是高级、资深人员,面向不同的人群,所需措辞也不同,同一个词因人不同的知识结构会导致不同的解读,所以尽量减少这种不必要的消化损耗。文章真正被阅读的受众,这个是无法控制的,事先定好基调就比较容易把握文章深度,浅显易懂最好不过了。 其次要 考虑到技术应用的上下文环境 ,这个要交待清楚,能解决什么问题,适用在什么场景下,如果能把类似的解决方案顺便提一下,更能阅读受众的知识面。 多使用图表。 一图胜千言,对于晦涩的算法、流程、结构等,一张漂亮的图,那怕是草图,也能使读者很容易走近文章的世界,吸收文章的精华内容。相比满屏的文字,图表会花费较少的时间被阅读接受。 新名词的使用要引出简要的注释,便于读者消化吸引。 由于 知识诅咒 的存在(通俗地说,就是一旦你知道了一个信息(学会了一样东西),你就很难想象你不知道该信息(没学会该东西)的情景。),总会有一些我们常用但别人却不懂的名词存在,这会加大阅读的难度,也会给读者一个放弃文章不再阅读的选择。 如果我在一篇文章中碰到了一个新名词,一般来讲我会去检索弄懂,如果另外的文章中还有,则会引起一连串的检索,那本来我要读的那篇文章就会越为越远离我的视线。当然,我没读完的有兴趣文章

Handout库:能将python脚本转化为html展示文件

随声附和 提交于 2021-01-01 11:00:39
有的时候我们需要将python代码进行展示讲解,这个时候使用py文件进行讲解效果并不是最好的。如果能转化为html文件,在浏览器中展示,那就完美了。好消息是存在一个名为handout的库可以实现我们的设想。 安装 pip3 install U handout 快速学习 下面是demo.py文件中的代码及注释,其中handout库可以将注释部分中的markdown标记转化为html相应的样式 """ # Python Handout库 将python脚本转化为带markdown标记形式的html文件 """ import handout import matplotlib . pyplot as plt import numpy as np """## 定义输出的文件夹""" doc = handout . Handout ( 'output' ) """ ## Markdown注释 以前后3个" 内的部分作为 markdown 待识别区域,可以用 markdown 语法书写注释 例如, handout 中出现下面的无序列表 - Headlines - Hyperlinks - Inline `code()` snippets - ** Bold ** and * italic * """ """ ## 添加文本和变量 注意这里使用 doc . add_text 方法向

java 线程安全和不安全

限于喜欢 提交于 2020-12-31 12:17:55
<div class="markdown_views"> <p><strong>线程安全</strong>就是多线程访问时,采用了<strong>加锁机制</strong>,当一个线程访问该类的某个数据时,进行保护,其他线程不能进行访问直到该线程读取完,其他线程才可使用。不会出现数据不一致或者数据污染。(Vector,HashTab;le) <br> <strong>线程不安全</strong>就是<strong>不提供数据访问保护</strong>,有可能出现多个线程先后更改数据造成所得到的数据是脏数据。(ArrayList,LinkedList,HashMap等)</p> <h2 id="概念"><a name="t0"></a>概念:</h2> <p>如果你的代码所在的进程中有多个线程在同时运行,而这些线程可能会同时运行这段代码。如果每次运行结果和单线程运行的结果是一样的,而且<strong>其他的变量的值也和预期的是一样的</strong>,就是线程安全的。或者说:一个类或者程序所提供的接口对于线程来说是原子操作或者多个线程之间的切换不会导致该接口的执行结果存在二义性,也就是说我们不用考虑同步的问题。线程安全问题都是<strong>由全局变量及静态变量</strong>引起的。 <br> 若每个线程中对全局变量、静态变量<strong>只有读操作</strong>

在家办公用什么软件?Mac办公必备软件推荐

假如想象 提交于 2020-12-31 11:03:59
说到办公软件,大家想当然的会觉得办公软件就是 office 的代名词,那么小编就给大家带来一些Mac上的办公软件吧! 里面当然会有我们大家都离不开的office了! Mac办公软件有哪些?Mac办公必备软件推荐马上就来! 一、ConceptDraw office for mac(矢量绘图工具) ConceptDraw office for mac(矢量绘图工具)是Macdown收集的Mac平台上一个强大的跨平台应用程序,能够快速简单的在你的文档中创建看起来非常专业的图表和插图。ConceptDraw office 4本身提供了强大的矢量绘图工具、库以及许多的预置的图例形状,内置描述语言、支持多种格式文档的输入输出、支持连接ODBC数据库和其它许多的功能。ConceptDraw office本身集成了流程图绘制软件ConceptDraw PRO,思维导图绘制软件ConceptDraw MINDMAP以及项目管理软件ConceptDraw PROJECT三款软件!本站提供其破解版,欢迎下载! 二、Microsoft office 2016 for Mac(办公套件) Microsoft office 2016 for Mac(办公套件)是Macdown第一时间收集的运行在Mac平台的微软办公软件。Microsoft office 2016 for Mac(是微软的一个庞大的办公软件集合

How to use set.seed() globally in R Markdown?

£可爱£侵袭症+ 提交于 2020-12-30 08:16:25
问题 Can someone please provide a working example of how to use set.seed() globally in R Markdown? I am aware of Yihui's documentation based on this bug report, but I get an error message when I put the suggested option in my setup chunk as knitr::opts_chunk$set(cache.extra = rand_seed) . What am I missing? I currently just have a random seed in the first code chunk that needs it, but later chunks should use the same seed. [UPDATE BELOW] My setup chunk: ```{r setup, include=FALSE} #knitr::opts

Add inline image in Rmarkdown

旧时模样 提交于 2020-12-30 08:12:03
问题 I can't find a way to insert an inline image on a markdown document I'm producing with RStudio. Seems like the RmarkDown Style Cheat sheet (https://www.rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf) does not mention such feature. Is this currently possible? Here's an example using html for a svg image: link: http://www.herongyang.com/HTML/HTML5-Add-Inline-SVG-Image-HTML5-Documents.html 回答1: Markdown syntax allows inline images: foo ![](image.png) bar 回答2: Could also use

Add inline image in Rmarkdown

这一生的挚爱 提交于 2020-12-30 08:10:06
问题 I can't find a way to insert an inline image on a markdown document I'm producing with RStudio. Seems like the RmarkDown Style Cheat sheet (https://www.rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf) does not mention such feature. Is this currently possible? Here's an example using html for a svg image: link: http://www.herongyang.com/HTML/HTML5-Add-Inline-SVG-Image-HTML5-Documents.html 回答1: Markdown syntax allows inline images: foo ![](image.png) bar 回答2: Could also use

Add inline image in Rmarkdown

烂漫一生 提交于 2020-12-30 08:08:26
问题 I can't find a way to insert an inline image on a markdown document I'm producing with RStudio. Seems like the RmarkDown Style Cheat sheet (https://www.rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf) does not mention such feature. Is this currently possible? Here's an example using html for a svg image: link: http://www.herongyang.com/HTML/HTML5-Add-Inline-SVG-Image-HTML5-Documents.html 回答1: Markdown syntax allows inline images: foo ![](image.png) bar 回答2: Could also use

Add inline image in Rmarkdown

孤街醉人 提交于 2020-12-30 08:06:57
问题 I can't find a way to insert an inline image on a markdown document I'm producing with RStudio. Seems like the RmarkDown Style Cheat sheet (https://www.rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf) does not mention such feature. Is this currently possible? Here's an example using html for a svg image: link: http://www.herongyang.com/HTML/HTML5-Add-Inline-SVG-Image-HTML5-Documents.html 回答1: Markdown syntax allows inline images: foo ![](image.png) bar 回答2: Could also use

【行业资讯】smart-doc 1.9.8 已经发布,Java Restful API 文档生成工具

时间秒杀一切 提交于 2020-12-29 22:21:47
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于java泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照javadoc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5文档,甚至可以直接生成Postman collection导入到Postman做api接口调试 smart-doc 1.9.8 已经发布,此版本更新内容包括: New Features 增加对抽象Controller方法的解析。 支持ResponseBodyAdvice通用接口响应包装设置。 忽略对Class对象的解析。 Bug Fixes 修改阿里版本dubbo注解名称解析错误。 修改模拟值生成错误。 修复类同时继承和基类和实现接口中可能出现字段重复的bug。 本文分享自微信公众号 - Laravel技术社区(Laravel360)。 如有侵权,请联系 support@oschina.cn 删除。 本文参与“ OSC源创计划 ”,欢迎正在阅读的你也加入,一起分享。 来源: oschina 链接: https://my.oschina.net/u/3372402/blog/4708798