mdoc 开源项目安装和使用教程

mdoc 开源项目安装和使用教程

mdoc Typechecked markdown documentation for Scala 项目地址: https://gitcode.com/gh_mirrors/md/mdoc

1. 项目的目录结构及介绍

scalameta/mdoc
├── github
├── bin
├── blog
├── cli/src/main/scala/mdoc
├── docs
├── mdoc-docs/src/main
├── mdoc-interfaces/src/main/scala/mdoc/interfaces
├── mdoc-js-interfaces/src/main/java
├── mdoc-js-worker/src/main
├── mdoc-js/src/main
├── mdoc-lsp/src/main/scala/mdoc
├── mdoc-sbt/src
├── mdoc/src/main
├── parser/shared/src/main/scala/mdoc/parser
├── project
├── runtime/src/main
├── tests
├── website
├── .git-blame-ignore-revs
├── .gitattributes
├── .gitignore
├── .jvmopts
├── .mergify.yml
├── .scala-steward.conf
├── .scalafmt.conf
├── LICENCE.md
├── NOTICE
├── build.sbt
├── evilplot.gif
├── readme.md
├── scatterplot.png
├── website.md

目录结构说明

• github: 相关的 GitHub 配置文件。
• bin: 可执行文件目录。
• blog: 博客相关文件。
• cli/src/main/scala/mdoc: 命令行接口的源代码。
• docs: 项目文档。
• mdoc-docs/src/main: mdoc 文档生成器的源代码。
• mdoc-interfaces/src/main/scala/mdoc/interfaces: mdoc 接口的源代码。
• mdoc-js-interfaces/src/main/java: JavaScript 接口的源代码。
• mdoc-js-worker/src/main: JavaScript 工作线程的源代码。
• mdoc-js/src/main: JavaScript 相关源代码。
• mdoc-lsp/src/main/scala/mdoc: Language Server Protocol 相关源代码。
• mdoc-sbt/src: sbt 插件的源代码。
• mdoc/src/main: mdoc 核心源代码。
• parser/shared/src/main/scala/mdoc/parser: 解析器的源代码。
• project: 项目构建配置。
• runtime/src/main: 运行时相关源代码。
• tests: 测试代码。
• website: 项目网站相关文件。
• .git-blame-ignore-revs: Git 责任忽略配置。
• .gitattributes: Git 属性配置。
• .gitignore: Git 忽略文件配置。
• .jvmopts: JVM 选项配置。
• .mergify.yml: Mergify 配置文件。
• .scala-steward.conf: Scala Steward 配置文件。
• .scalafmt.conf: Scala 格式化配置文件。
• LICENCE.md: 许可证文件。
• NOTICE: 通知文件。
• build.sbt: sbt 构建配置文件。
• evilplot.gif: 图片文件。
• readme.md: 项目说明文件。
• scatterplot.png: 图片文件。
• website.md: 网站相关 Markdown 文件。

2. 项目的启动文件介绍

项目的启动文件主要是 build.sbt，它是 sbt 构建工具的配置文件，用于定义项目的依赖、版本等信息。

// build.sbt 示例内容
name := "mdoc"

version := "2.6.1"

scalaVersion := "2.13.8"

libraryDependencies ++= Seq(
  "org.scalameta" %% "mdoc" % "2.6.1",
  "org.scalatest" %% "scalatest" % "3.2.10" % Test
)

build.sbt 文件说明

• name: 项目名称。
• version: 项目版本。
• scalaVersion: 使用的 Scala 版本。
• libraryDependencies: 项目依赖的库。

3. 项目的配置文件介绍

.gitignore

.gitignore 文件用于配置 Git 忽略的文件和目录，避免将不必要的文件提交到版本控制中。

# .gitignore 示例内容
*.class
*.log
*.out
target/

.scalafmt.conf

.scalafmt.conf 文件用于配置 Scala 代码格式化工具的选项。

# .scalafmt.conf 示例内容
version = 2.4.2
maxColumn = 120

.jvmopts

mdoc Typechecked markdown documentation for Scala 项目地址: https://gitcode.com/gh_mirrors/md/mdoc