md2key 项目使用教程

md2key 项目使用教程

md2keyConvert markdown to keynote项目地址:https://gitcode.com/gh_mirrors/md/md2key

目录结构及介绍

md2key 项目的目录结构如下：

md2key/
├── assets/
│   └── default.key
├── bin/
│   └── md2key
├── lib/
│   ├── md2key/
│   │   ├── converter.rb
│   │   ├── keynote.rb
│   │   └── version.rb
│   └── md2key.rb
├── scripts/
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
└── md2key.gemspec

目录介绍

• assets/: 包含默认的 Keynote 模板文件。
• bin/: 包含可执行文件 md2key。
• lib/: 包含项目的核心代码。
  • md2key/: 包含转换器和 Keynote 操作的相关代码。
  • md2key.rb: 主入口文件。
• scripts/: 包含一些辅助脚本。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• Gemfile: Ruby 依赖管理文件。
• LICENSE.txt: 项目许可证。
• README.md: 项目说明文档。
• Rakefile: Rake 任务配置文件。
• md2key.gemspec: RubyGem 配置文件。

项目的启动文件介绍

项目的启动文件是 bin/md2key。这个文件是一个可执行脚本，用于启动 md2key 工具。

#!/usr/bin/env ruby

require 'md2key'

Md2key::CLI.start

启动文件介绍

• #!/usr/bin/env ruby: 指定使用 Ruby 解释器运行脚本。
• require 'md2key': 引入 md2key 库。
• Md2key::CLI.start: 启动命令行接口。

项目的配置文件介绍

项目的配置文件主要是 Gemfile 和 md2key.gemspec。

Gemfile

Gemfile 用于管理项目的 Ruby 依赖。

source 'https://rubygems.org'

gem 'md2key'

md2key.gemspec

md2key.gemspec 是 RubyGem 的配置文件，包含项目的详细信息和依赖。

Gem::Specification.new do |spec|
  spec.name          = "md2key"
  spec.version       = Md2key::VERSION
  spec.authors       = ["Takashi Kokubun"]
  spec.email         = ["takashikkbn@gmail.com"]
  spec.summary       = %q{Convert markdown to keynote}
  spec.description   = %q{md2key converts Markdown documents to Apple Keynote presentations}
  spec.homepage      = "https://github.com/k0kubun/md2key"
  spec.license       = "MIT"

  spec.files         = `git ls-files -z`.split("\x0")
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_dependency "oga", ">= 1.2"
  spec.add_dependency "redcarpet", ">= 3.3"
  spec.add_dependency "thor", ">= 0.19"

  spec.add_development_dependency "bundler"
  spec.add_development_dependency "pry"
  spec.add_development_dependency "rake"
end

配置文件介绍

• spec.name: 项目名称。
• spec.version: 项目版本。
• spec.authors: 作者信息。
• spec.email: 作者邮箱。
• spec.summary: 项目简述。
• spec.description: 项目详细描述。
• spec.homepage: 项目主页。
• spec.license: 项目许可证。
• spec.files: 项目文件列表

md2keyConvert markdown to keynote项目地址:https://gitcode.com/gh_mirrors/md/md2key