首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

通过Dokka (Kotlin)生成文档后,如何将文档发布到Github页面?

要将通过Dokka生成的文档发布到Github页面,可以按照以下步骤进行操作:

  1. 首先,确保你已经在本地安装了Git,并且已经在Github上创建了一个仓库用于存放文档。
  2. 在终端或命令行中,进入到你的项目目录下。
  3. 使用Git命令将项目初始化为一个Git仓库:git init
  4. 将生成的文档文件夹添加到Git仓库中:git add <文档文件夹路径>
  5. 提交文档文件夹的更改:git commit -m "Add generated documentation"
  6. 在Github上创建一个新的分支,用于存放文档:git branch gh-pages
  7. 切换到gh-pages分支:git checkout gh-pages
  8. 将gh-pages分支推送到Github上的仓库:git push origin gh-pages
  9. 现在,你的文档已经被推送到了Github上的gh-pages分支。可以通过访问https://<你的用户名>.github.io/<仓库名>来查看文档。

请注意,上述步骤假设你已经正确配置了Git和Github,并且具有相应的权限来推送更改到仓库。此外,你需要将<文档文件夹路径>替换为实际的文档文件夹路径。

关于Dokka和Kotlin的更多信息,你可以参考以下链接:

  • Dokka官方网站:https://github.com/Kotlin/dokka
  • Kotlin官方网站:https://kotlinlang.org/
页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

Kotlin 文档注释的生成-Dokka 1.6.0

需要提供规范的API帮助文档Kotlin和java类似,提供了一个Kdoc的工具帮助进行注释文档生成。...5.生成注释文档 Kotlin的注释文档生成需要使用一个Dokka的工具进行:https://github.com/Kotlin/dokka Dokka支持java和Kotlin混合项目生成KDoc文档...Dokka生成之后支持四种模式: html - 默认导出的就是html文档 javadoc - 你如果喜欢javadoc的风格,也可以导出为javadoc风格 gfm - GitHub flavored...markdown jekyll - Jekyll compatible markdown 两种就是github 和jekyll的 markdown风格了 5.1 命令行模式 如果我们想直接通过命令行生成注释...生成的速度会有点慢,稍微给点耐心慢慢等待。 生成的注释文档 在app/build/dokka 文件夹下。

53710

2023 Kotlin 路线图重点:改进库作者体验

Kotlin 团队明白,作者的工作对所有用户都相当重要。因此,我们希望通过工具和文档来提供支持。库作者体验是 2023 年 Kotlin 路线图的一大首要优先事项。...Kotlin 路线图: https://kotlinlang.org/docs/roadmap.html 在这篇博文中,我们将进一步介绍我们的计划和已经完成的工作,特别是 Dokka 文档更新。...Dokka 稳定版本 KT-48998 使用 HTML 输出稳定 Dokka发布完全修改的 Dokka 文档。...列出有助于库开发(包括项目设置、确保向后兼容和发布)的工具。 隆重推出新的 Dokka 文档! 查看经过重写的、更加人性化的 Dokka 文档,并告诉我们您的想法。...我们还重新组织了页面结构,添加了更多配置示例,并提供了配置选项描述来帮助新手更快入门。 要详细了解有关针对库作者的计划改进和其他 Kotlin 计划,请查看 Kotlin 路线图。

41810
  • API 库的文档体系支持:主流编程语言的文档设计

    文档编写方式上来看,Rust、Julia、Dart、Kotlin、Swift 的文档工具都是相似的:基于 markdown 语法的基础上,进行了一系列的定制。...如 Rustdoc 会编译、运行文档中的代码,可以通过 Rust 自身提供的断言语法(如 assert_eq!)进行测试。...编译上述的测试代码 (如果编译失败,则说明测试失败) 运行这些测试 or 文档 如下是 Rustdoc 中将上述的代码生成测试代码的测试用例: #!...如 KotlinDoc/KDoc 中使用的 Dokka,使用 [] 来链接元素,这种方式和 markdown 比较贴进。 文档编排。...文档需要输出程序的输出,它可以通过运行对应的测试,并保持两者是一致的。 主要的实现步骤可以参见上述的 Rust 语言实现。 3.

    78620

    架构即代码:编码下一代企业(应用)架构体系

    在先前的一系列的代码化(https://ascode.ink/)文章中,描述了如何将软件开发完全代码化,包含了将文档、需求、设计、代码、构建、部署、运营等变成代码化。...接下来的问题就是,如何将这个理念有机的与系统结合在一起?并友好地提供这样的 API 接口(DSL)?...即所有的 “代码” 都通过 markdown 来管理,优点有一大堆: 使用内嵌 DSL (用语法块管理)表述架构 可以记录系统的架构文档,如架构决策、业务架构等 拥有广泛的解析库,能提供更灵活的定制灵感...),用于创建代码仓库的分析: repos {repo(name = "Backend", language = "Kotlin", scmUrl = "https://github.com/archguard...如同,我们构建 ArchGuard 的软件开发模型,也是执行-探索(execute-explore),先从分析一下系统(发布一个分析功能),再配合已有的模式,最后得到 “结论” 或者规则(再发布一个 linter

    53840

    【Android Gradle 插件】自定义 Gradle 插件模块 ⑤ ( 完整总结 ) ★★★

    publishing 扩展 , 在该扩展中 , 可以在其中的 publications 脚本块 中为插件传入参数 ; 注意 : publications 中的 plugin 函数是任意命名的 ; // 发布...publications / xxx / artifactId 配置中 自己指定 插件名称 ; // 用于将 插件上传到 远程仓库 或者 本地仓库 中 apply plugin: 'maven-publish' // 发布...publishing / publications 脚本块中 自己指定 // 用于将 插件上传到 远程仓库 或者 本地仓库 中 apply plugin: 'maven-publish' // 发布...publishing / publications 脚本块中 自己指定 // 用于将 插件上传到 远程仓库 或者 本地仓库 中 apply plugin: 'maven-publish' // 发布...publishing / publications 脚本块中 自己指定 // 用于将 插件上传到 远程仓库 或者 本地仓库 中 apply plugin: 'maven-publish' // 发布

    1.4K20

    场景驱动的 AI 体验设计:如何让智能 IDE 赋能遗留系统重写

    即以 IDE 为媒介,持续将其他的开发活动集成 IDE 中,诸如文档查询、API 接入等等。...场景:遗留系统改造 对于编码和其它场景,在我先前的《上下文工程:基于 Github Copilot 的实时能力分析与思考》 等文档,以及 NJSD 大会的《从个人组织, AIGC技术的工程化落地》上的分享里...即通过聊天的方式,获得一些创意式的输入,以知道什么是更好的架构。 业务信息提取。即通过文档生成、调用链分析等方式,分析某一个 API 的业务与实现逻辑。 基础设施重写。...而我们所推荐的一种方式就是活文档。活文档的方式有多种多样的,在代码中一种比较简单的实现方式就是通过注解。...我们应该思考:如何将生成式 AI 应用对更有价值的日常活动中?我们应该思考:如何将更多的自主性和决定权交由用户?

    31030

    Spring Boot 2.4.4、Spring Cloud 2020.0.2 发布

    中国古人常说,好事成双,前两天Oracle刚刚宣布了JAVA16的发布(链接),这不,Spring Boot 2.4.4和Spring Cloud 2020.0.2也都一起发布了最新版本。...Java 16支持 #25527 改进Mockito测试执行监听器的文档 #25513 突出显示参考文件中致动器API文件的链接 #25510 修复gradle插件文档中的属性名 #25454 修复文档中的语法错误...#25411 修复生成信息目标描述中的措辞错误 #25385 Polish HTTP 客户端文档措辞优化 #25371 记录DataSourceBuilder支持的数据源实现 #25333 添加有关应用程序...yml和属性文件优先级的注释 #25300 说明如何将Docker密码导入configtree #25095 警告:无法使用@PropertySource或@TestPropertySource加载多文档属性文件...Mail 1.6.6 #25639 Upgrade to Tomcat 9.0.44 #25640 Upgrade to Undertow 2.2.5.Final #25641 具体地址:https://github.com

    1.7K20

    第一款Goland的SCA插件开发之旅

    举一个例子,希望能够通过插件能够创建文件,在找遍了官方的文档,只发现了以下内容: 文档里面提到可以使用 PsiDirectory 中的 add 方法来保存 PSI 文件,但它没说 HOW!...在我理解,这个版本应该是对应到 Goland 中的版本,而 IDEA 的版本可以参考官方的版本列表页面。报错中的链接则是各个 IDEA 的发布信息。...最初的想法是通过 JPanel 来进行展示,后来发现比较费劲,后来还是通过生成一个 markdown 格式的报告文件,展示效果如下: # github.com/madneal/gshark v0.2...直接通过 Github 中的 Use this template 就可以通过这个模板创建自己的项目。模板默认的开发语言是 kotlin,当然也可以选择 Java。...同时,如果希望通过 Github 来进行插件的发布,还需要进行以下配置项的配置。 至此,插件的开发,发布过程基本都打通了,后续的发布过程也比较简单。

    1.4K20

    聚焦 Android 11: 大功告成

    深入了解 Hilt 等主要发布,包括帮助您入门的 速查表 (cheat sheets),以及我们迁移了自己的示例将 Hilt 用于依赖项注入 的过程。更少样板 = 更多乐趣。...欢迎了解如何将您的应用扩展 手机 和 Chrome 操作系统 上的 Android 开发之外的最佳实践。 Wear OS : 了解该平台即将在今年秋季发布的版本中进行的 改进。...通过新的 Codelab,帮助您顺利将 Android Performance Tuner 和 Google Play Asset Delivery 集成 Unity 或原生 C/C++ 游戏中。...了解如何 优化商品详情页面 才能充分利用 Google Play 大幅增强的游戏视觉体验,以及新的 应用内评价 (In-app review) API 如何让您选择提示用户无需返回应用详情页面即可在游戏中留下评论...要了解如何将其添加到您的应用,请查看 技术文档 和 示例应用。 我们 建议 您参考 Material Design 指南,确保应用一致运行,同时确保应用的使用习惯可以延续。

    2K30

    Gradle Kotlin DSL指南

    您可以通过查看应用插件的文档或运行gradle kotlinDslAccessorsReport来发现可用的扩展和约定,该报告打印了访问所有应用插件提供的模型元素所必需的Kotlin代码。...例如,Gradle的Android Plugin没有发布Gradle Plugin Portal,并且——至少在插件3.2.0版本之前——解析给定插件标识符的构件所需的元数据没有发布谷歌存储库。...发布插件时,请使用Gradle内置的Gradle Plugin Development Plugin。它通过plugins{}块自动发布所需的元数据,使您的插件可用。...在本节中,我们将向您展示如何将Android Plugin应用于单个项目构建或多项目构建的根项目。目的是指导构建如何将com.android.application插件标识符映射到可解析工件。...-jvm-target=1.8 将生成的JVM字节码的目标版本设置为1.8。

    10.2K20

    Compose 线上分享会内容

    通过「底层原理」寻找答案。...可根据 composeOptions 来自由配置 compose 版本,但版本需要参考兼容性文档 AGP 7.0 以下不支持 ArtProfileTask,这会导致无法生成 baseline.prof...对于要不要使用 Compose 这个问题,我的建议是:先尝试了解,学习官方文档,然后尝试写一些 Demo,对照着公司的项目,用 Compose 去仿写几个页面,如果整体问题不大的话,可以尝试对公司项目的二三级页面进行改造...不过话也说回来,Jetpack Compose 容器依然是一个 ViewGroup,没有脱离原生 View 体系,我觉得,问题应该不会太大,最多就是代码使用不当,重组作用域扩大,导致页面卡顿,但这种在开发期间是可以通过调试和监控可发现的...target=https%3A%2F%2Fgoogle.github.io%2Faccompanist%2F [9] Compose 博物馆文档: https://jetpackcompose.cn/docs

    1.2K10

    解密!第一个开源架构工作台的构建过程

    当然了,要获取更详细的信息,需要从 GitHub 上拉取最新的代码。...原型参考与设计:可交互环境与文档体验 什么是文档?什么是代码?两者没有一个明确的界限,文档是可执行的,代码也是可执行的。不过,从最终的形态上来说,它们都是知识。所以,重点依旧在于如何将这些知识显式化。...落地:构建数据通讯与结果呈现 为了验证整个 PoC (Proof of Concept,概念证明)是可行的,接下来就是让数据作为胶水把一切串联起来,构建这样一个完整的端端示例: 前端 → REPL。...数据传输与处理:Message 模型 在 REPL 服务中,通过 WebSocket 接收到前端的数据之后,就需要将其转换为对应的数据,并返回给前端。...总结 虽然,我们发布了这个测试版本,但是它依旧有一系列需要改善的地方,诸如于: DSL 体系架构设计。与 Ktor 的 DSL 设计与实现相比,ArchGuard DSL 显得没有任何设计。

    1.2K10

    Kotlin练手,以登录为例,Anko简单使用

    Kotlin还不是正房的时候就听说过了,除了Java之外也能开发Android APP的一种语言,小众鲜为人知,甚至介绍都不多。...最近Kotlin1.2版本发布又是一波大范围的推送,而且在GitHub的排名也不断上升。 Google一系列的动作都在加快Kotlin在Android领域取代Java的速度。...Kotlin官方文档(英文版) Kotlin官方文档(中文版) Anko——JetBrains开发的一个强大的库 以登录为例,小小练手 package com.yechaoa.kotlinforlogin...,语法简单,结构清晰,但是不能预览,预览插件: https://github.com/Kotlin/anko/wiki/Anko-Layouts#anko-support-plugin Java...代码转换为 Kotlin ctrl +alt + shift + k GitHub:https://github.com/yechaoa/KotlinForLogin

    47520
    领券