TTY::Markdown 项目教程

40 0 0

TTY::Markdown 项目教程

tty-markdownConvert a markdown document or text into a terminal friendly output.项目地址:https://gitcode.com/gh_mirrors/tt/tty-markdown

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

TTY::Markdown 项目的目录结构如下：

tty-markdown/ ├── bin/ ├── examples/ ├── lib/ │ └── tty/ │ └── markdown.rb ├── spec/ ├── tasks/ ├── .editorconfig ├── .gitignore ├── .rspec ├── .rubocop.yml ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── Gemfile ├── LICENSE.txt ├── README.md ├── Rakefile ├── appveyor.yml └── tty-markdown.gemspec

目录介绍

bin/: 包含可执行文件。
examples/: 包含示例文件。
lib/: 包含项目的主要代码文件，其中 tty/markdown.rb 是核心文件。
spec/: 包含测试文件。
tasks/: 包含任务文件。
.editorconfig, .gitignore, .rspec, .rubocop.yml: 配置文件。
CHANGELOG.md, CODE_OF_CONDUCT.md, Gemfile, LICENSE.txt, README.md, Rakefile, appveyor.yml, tty-markdown.gemspec: 项目文档和元数据文件。

2. 项目的启动文件介绍

TTY::Markdown 项目的启动文件是 lib/tty/markdown.rb。这个文件包含了项目的主要逻辑和功能实现。

启动文件内容


# lib/tty/markdown.rb
require 'kramdown'
require 'pastel'
require 'rouge'
require 'strings'
require 'tty-color'
require 'tty-screen'
 
module TTY
  class Markdown
    # 主要逻辑和功能实现
  end
end

3. 项目的配置文件介绍

TTY::Markdown 项目的配置文件主要包括：

.editorconfig: 用于统一不同编辑器和IDE的编码风格。
.gitignore: 指定不需要被 Git 跟踪的文件和目录。
.rspec: 配置 RSpec 测试框架。
.rubocop.yml: 配置 RuboCop 代码风格检查工具。
Gemfile: 定义项目所需的 RubyGems。
Rakefile: 定义 Rake 任务。
tty-markdown.gemspec: 定义 gem 的元数据和依赖。

配置文件示例

`.editorconfig`


root = true
 
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

`.gitignore`

/.bundle /.yardoc /_yardoc /coverage /doc /pkg /spec/fixtures/generated /tmp *.gem *.rbc *.swp *~

`.rspec`

--color --format documentation

`.rubocop.yml`

AllCops: Exclude: - 'bin/**/*' - 'spec/**/*' - 'vendor/**/*'

`Gemfile`

source 'https://rubygems.org' gem 'tty-markdown'

`Rakefile`

require 'bundler/gem_tasks' require 'rspec/core/rake_task' RSpec::Core::RakeTask.new(:spec) task default: :spec

`tty-markdown.gemspec`


Gem::Specification.new do |spec|
  spec.name          = 'tty-markdown'
  spec.version       = '0.7.2'
  spec.authors       = ['Piotr Murach']
  spec.email         = ['piotr@piotrmurach.com']
  spec.summary       = %q{Convert a markdown document or text into a terminal friendly output.}
  spec.description   = %q{Convert a markdown document or text into a terminal friendly output.}
  spec.homepage      = 'https://github.com/piotrmurach/tty-markdown'
  spec.license