不晓得大家有没有这样的需要：我的项目工程想规范化，有一些要害类的阐明文档; 或者刚接手了一个不堪入目，没有正文的工程，每次找一些要害类的时候，总是靠记忆或者其余笔记去关上。

明天在梳理接手的工程时候，想让写一个 ReadMe 文档，并且能够跳转关上一些文件，比方某些要害类。先看成果：

这个成果很大地满足了我的需要。为了达到这个成果，须要具备 2 个知识点：

1. Markdown 语法: 不理解同学的能够百度下，不到 10 分钟你就能够成为一个 Markdown 入门选手
2. 跳转文件链接的配置

Markdown 配置与语法

1. 装置 Markdown 插件：Preferences→Plugins->Marketplace→装置 Markdown 插件，重启 Android Studio
2. 在工程目录中适当的地位创立以 ”README.md” 文件 (以 md 结尾的 Markdown 文件即可)
3. 复制上面这段 md，按住 Ctrl + 鼠标左键 or Command + 鼠标左键，即可跳转关上指定的文件，包含文件夹

[测试](build.gradle)

Markdown 根底语法：

1. 代表着题目，几个 #代表这个几级的题目

2. [显示的文本](跳转的链接)：中拓号用于显示预览的文本，括号内是链接地址，能够网址，也能够是本文中的文件地址

上文动图，能够参考自己 GitHub 工程

文件援用门路的生成

下面动图应用到的文件门路 [app/src/main/java/com/ben/template/XApplication.kt]，有肯定的规定：必须是从我的项目的根目录作为起始门路，而不是在电脑系统中的绝对路径。所以这里要应用一个命令：Path From Respository Root，能够通过以下 2 个形式去找到

1. 菜单栏→Edit→Copy 找到
2. 设置项 Preferences→Keymap→间接搜寻并增加快捷键

其余

1. Markdown 举荐编辑器：马克飞象 这个编辑器是我入坑 Markdown 以来始终在用的，渲染成果好，能够导出 pdf、md、html。
2. Android Studio 上还能够通过 Favorites 面板来保留须要的文件，也能够通过书签 Bookmarks 来保留，有相应的快捷键

GitHub 工程