关于新版文档说明以及衍生的话题

admin
admin 2021-03-04 15:28
阅读需:0

关于这个新版md文档,最近有很多人问怎么看,我觉得这个问题很严重,需要好好讲一下:

1. 没有html和pdf版本是因为文档太大了,有500m,之前排版比较好的工具都试过了不可行,如果大家有好的办法可以推荐给我,我去构建再上传

2. 下载看到这个文档不知道怎么打开,其实这也是看大家自行解决问题的能力,我正常情况遇到不了解的问题一般会这么做:

 1)看到是.md文件结尾,不知道怎么打开,第一步会去搜索:md结尾的文件是什么

2)点进去看介绍可以知道这是一种名为 markdown 格式的文件,第一个搜索结果里也直接给出了一种阅读器的名字

3) 如果下载这个阅读器打开后感觉效果不好,那我会继续搜索:markdown推荐阅读器,同样点开非广告的第一个搜索结果,可以看到有很多推荐,这里我们推荐第三个


3. 以上操作花费不超过两分钟,希望大家遇到问题可以尝试自己解决,而不是一有问题直接就抛群里等回复,typora打开后效果如下。

(BladeX开发手册在BladeX老伙计群文件 06 开发手册 目录下载)

4. 如果要部署在网页上查看,可以直接推送到git项目,在线阅览就行,下图为coding.net的git效果。

注意⚠️:一定要推送到私有git,否则公布到外网被人举报会算作违反商业协议受到处罚

5. 其实很多问题都是这种摸索的思路,逐步查询,凝练关键字,自己解决问题也能随着提升,总比遇到问题不经过思考直接就问强。

6. 大家遇到问题推荐把问题发到技术社区,详细描述一下,写问题的时候自己也想一想,如果别人看到这个问题能不能看懂。技术社区地址:https://sns.bladex.vip,如何正确地提问:https://sns.bladex.vip/article-14934.html

7. 有些小伙伴一年前同时进群,水平差不多,现在一部分人已经可以跟着源码调试,自行解决并且还能帮新人解答部分问题了。但仍有一部分人问的问题、解决问题的办法一年过后还是相对初级。这不是贩卖焦虑,希望大家能有危机感。

8. 文字比较多,会有很多人不想看,但我觉得能有1%的人看进去那也值了。希望大家花了钱,使用BladeX后能掌握更多平常工作养成不了的好习惯,这些学到了都是自己以后升职加薪的资本。


评论
  • 北京智鼎优源
    2021-03-09 15:49
    1. 如果过大没法打包成一份PDF是否可以试试拆分成2~3个PDF也可以。我个人觉得不必一个PDF包含所有内容。 2. 我是使用IDEA直接打开文件夹当项目打开的。毕竟全局搜索还是方便些。 另外推荐,IDEA一个markdown插件: Markdown Navigator enhanced edition ,收费的,可以找办法pj。 3. 是否可以把这些文档文件夹 推到私有库,看BladeX-Doc项目停用了,是否可以恢复使用。 回头更新,提交PR或者issues也方便。
    6 回复
  • admin
    2021-05-17 15:36
    @北京智鼎优源 之前尝试生成pdf,需要把图片压缩,并且用高性能服务器才能生成成功。因为文档太大了,mac笔记本和8核32g的window机子都无法生成,直接卡死了。所以就提供了md源文件。 服务器资源已经很紧张,这么庞大的文档就不放上去了,后续空了会单独建一个在线的文档系统,可以在线阅览
    5 回复