markdown_ruby_documentation 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +9 -0
  3. data/.rspec +3 -0
  4. data/.travis.yml +4 -0
  5. data/CODE_OF_CONDUCT.md +13 -0
  6. data/Gemfile +4 -0
  7. data/LICENSE.txt +21 -0
  8. data/README.md +134 -0
  9. data/Rakefile +6 -0
  10. data/bin/console +14 -0
  11. data/bin/setup +7 -0
  12. data/lib/github-markdown.css +656 -0
  13. data/lib/markdown_ruby_documentation.rb +29 -0
  14. data/lib/markdown_ruby_documentation/constants_presenter.rb +38 -0
  15. data/lib/markdown_ruby_documentation/default_erb_methods.rb +11 -0
  16. data/lib/markdown_ruby_documentation/generate.rb +107 -0
  17. data/lib/markdown_ruby_documentation/git_hub_link.rb +74 -0
  18. data/lib/markdown_ruby_documentation/git_hub_project.rb +29 -0
  19. data/lib/markdown_ruby_documentation/instance_to_class_methods.rb +44 -0
  20. data/lib/markdown_ruby_documentation/markdown_presenter.rb +36 -0
  21. data/lib/markdown_ruby_documentation/method.rb +101 -0
  22. data/lib/markdown_ruby_documentation/method/class_method.rb +13 -0
  23. data/lib/markdown_ruby_documentation/method/instance_method.rb +11 -0
  24. data/lib/markdown_ruby_documentation/method/null_method.rb +28 -0
  25. data/lib/markdown_ruby_documentation/method_linker.rb +41 -0
  26. data/lib/markdown_ruby_documentation/print_method_source.rb +19 -0
  27. data/lib/markdown_ruby_documentation/reject_blank_methods.rb +9 -0
  28. data/lib/markdown_ruby_documentation/summary.rb +32 -0
  29. data/lib/markdown_ruby_documentation/template_parser.rb +348 -0
  30. data/lib/markdown_ruby_documentation/version.rb +3 -0
  31. data/lib/markdown_ruby_documentation/write_markdown_to_disk.rb +29 -0
  32. data/markdown_ruby_documenation.gemspec +30 -0
  33. metadata +162 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: d39e3d18cd3a64d5b953bbacef111b3628327fad
4
+ data.tar.gz: ab5e4c28c68bba449977477e375fac1b89db4e14
5
+ SHA512:
6
+ metadata.gz: afa43b83d03e03e1e97c5ae87d7e319885ae111c02b1ea7c6d6d09d31ac85b8f4beee1d8fc8b579db929e1ed29513ba25ba82a88e20e9c15488726caeb379ad5
7
+ data.tar.gz: 69c1b5800e28bfc574ecc51a981679bacd06147abf46e5efaa6408f942f3d9f468fc18e6ca1081a22d01c5e12cff07eca8fc1d6eff9ad6d513cd8642fada9240
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.7
4
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+ gem "simplecov"
3
+ # Specify your gem's dependencies in business_rule_documentation.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Dustin Zeisler
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,134 @@
1
+ # MarkdownRubyDocumentation
2
+
3
+ Gem provides the ability to use markdown and ruby ERB with some helper methods inside of comments. The comment area then can be generated into a markdown file.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'markdown_ruby_documentation'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install markdown_ruby_documentation
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ class RubyClassToBeInspected
25
+ MY_VALUE = 10
26
+
27
+ #=mark_doc
28
+ # **I am Documentation**
29
+ # <%= print_method_source "#i_am_a_documented_method" %>
30
+ # ^`MY_VALUE`
31
+ #=mark_end
32
+ def i_am_a_documented_method
33
+ "Hello"
34
+ end
35
+ end
36
+
37
+ html_generator = MarkdownRubyDocumentation::HtmlGenerator.new(
38
+ dir: <Output Directory>
39
+ )
40
+
41
+ MarkdownRubyDocumentation::Generate.run(
42
+ subjects: [RubyClassToBeInspected],
43
+ output_proc: html_generator
44
+ ).call
45
+ ```
46
+
47
+ ### Resulting file
48
+
49
+ ```markdown
50
+ # Ruby Class To Be Inspected
51
+
52
+ ## I am a documented method
53
+
54
+ **I am Documentation**
55
+ "Hello"
56
+ [MY_VALUE](/ruby_class_to_be_inspected#my_value)
57
+
58
+ ```
59
+
60
+ ### ERB Methods
61
+
62
+ #### `print_method_source(method)`
63
+ The source of a method block returned as text.
64
+
65
+ #### `eval_method(method)`
66
+ The result of evaluating a method.
67
+
68
+ #### `print_mark_doc_from(method)`
69
+ Prints out the mark doc from another method.
70
+
71
+ #### `print_raw_comment(method)`
72
+ Prints out any comments proceeding a method def.
73
+
74
+ #### `git_hub_method_url(method)`
75
+ Creates a url to the method location on GitHub based on the current sha or it defaults to master.
76
+
77
+ ##### `git_hub_file_url(file_path || Class)`
78
+ Creates a url to the file on GitHub based on the current sha or it defaults to master.
79
+
80
+
81
+ ##### Example method reference inputs
82
+
83
+ * ".class_method_name" class method in the current scope.
84
+ * "Constant.class_method_name" class method on a specific constant.
85
+ * "SomeClass#instance_method_name" an instance method on a specific constant.
86
+ * "#instance_method_name" an instance method in the current scope.
87
+ * `__method__` returns `#<current_method_name>`
88
+
89
+ #### `pretty_code(ruby_source)`
90
+ Convert underscore methods to more English like sentence.
91
+
92
+ #### `link_local_methods_from_pretty_code(pretty_code, include: <Optional array of matching strings>)`
93
+ link_local_methods_from_pretty_code("`hello i am a method`") => "[hello i am a method](#hello-i-am-a-method)"
94
+
95
+ #### `format_link`
96
+ format_link "#i_do_other_things" => [I do other things](#i-do-other-things)
97
+ format_link "The method 10", "#i_do_other_things" => [The method 10](#i-do-other-things)
98
+
99
+ Instance method that call other methods will results in an error.
100
+
101
+ #### `method_as_local_links`
102
+ method_as_local_links("i_return_one + i_return_two") => "^`i_return_one` + ^`i_return_two`"
103
+
104
+ #### `constants_with_name_and_value`
105
+ constants_with_name_and_value("SOME_CONST_VALUE") => "`SOME_CONST_VALUE => "1"`"
106
+
107
+ #### `quoted_strings_as_local_links(text, include: <Optional array of matching strings>)`
108
+ quoted_strings_as_local_links('"this is Bob"') => "^`the_is_bob`"
109
+
110
+ #### `ruby_to_markdown`
111
+ Converts case statements and if statements to bulleted markdown
112
+
113
+ #### `readable_ruby_numbers`
114
+ Add commas to any ruby numbers. To provide additional formatting it yields a block given the number object.
115
+
116
+ #### `hash_to_markdown_table(hash, key_name:, value_name:)`
117
+
118
+ #### `array_to_markdown_table(array, key_name:)`
119
+
120
+ ## Development
121
+
122
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
123
+
124
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
125
+
126
+ ## Contributing
127
+
128
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/business_rule_documentation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
129
+
130
+
131
+ ## License
132
+
133
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
134
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "markdown_ruby_documentation"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,656 @@
1
+ @font-face {
2
+ font-family: octicons-link;
3
+ src: url(data:font/woff;charset=utf-8;base64,d09GRgABAAAAAAZwABAAAAAACFQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABEU0lHAAAGaAAAAAgAAAAIAAAAAUdTVUIAAAZcAAAACgAAAAoAAQAAT1MvMgAAAyQAAABJAAAAYFYEU3RjbWFwAAADcAAAAEUAAACAAJThvmN2dCAAAATkAAAABAAAAAQAAAAAZnBnbQAAA7gAAACyAAABCUM+8IhnYXNwAAAGTAAAABAAAAAQABoAI2dseWYAAAFsAAABPAAAAZwcEq9taGVhZAAAAsgAAAA0AAAANgh4a91oaGVhAAADCAAAABoAAAAkCA8DRGhtdHgAAAL8AAAADAAAAAwGAACfbG9jYQAAAsAAAAAIAAAACABiATBtYXhwAAACqAAAABgAAAAgAA8ASm5hbWUAAAToAAABQgAAAlXu73sOcG9zdAAABiwAAAAeAAAAME3QpOBwcmVwAAAEbAAAAHYAAAB/aFGpk3jaTY6xa8JAGMW/O62BDi0tJLYQincXEypYIiGJjSgHniQ6umTsUEyLm5BV6NDBP8Tpts6F0v+k/0an2i+itHDw3v2+9+DBKTzsJNnWJNTgHEy4BgG3EMI9DCEDOGEXzDADU5hBKMIgNPZqoD3SilVaXZCER3/I7AtxEJLtzzuZfI+VVkprxTlXShWKb3TBecG11rwoNlmmn1P2WYcJczl32etSpKnziC7lQyWe1smVPy/Lt7Kc+0vWY/gAgIIEqAN9we0pwKXreiMasxvabDQMM4riO+qxM2ogwDGOZTXxwxDiycQIcoYFBLj5K3EIaSctAq2kTYiw+ymhce7vwM9jSqO8JyVd5RH9gyTt2+J/yUmYlIR0s04n6+7Vm1ozezUeLEaUjhaDSuXHwVRgvLJn1tQ7xiuVv/ocTRF42mNgZGBgYGbwZOBiAAFGJBIMAAizAFoAAABiAGIAznjaY2BkYGAA4in8zwXi+W2+MjCzMIDApSwvXzC97Z4Ig8N/BxYGZgcgl52BCSQKAA3jCV8CAABfAAAAAAQAAEB42mNgZGBg4f3vACQZQABIMjKgAmYAKEgBXgAAeNpjYGY6wTiBgZWBg2kmUxoDA4MPhGZMYzBi1AHygVLYQUCaawqDA4PChxhmh/8ODDEsvAwHgMKMIDnGL0x7gJQCAwMAJd4MFwAAAHjaY2BgYGaA4DAGRgYQkAHyGMF8NgYrIM3JIAGVYYDT+AEjAwuDFpBmA9KMDEwMCh9i/v8H8sH0/4dQc1iAmAkALaUKLgAAAHjaTY9LDsIgEIbtgqHUPpDi3gPoBVyRTmTddOmqTXThEXqrob2gQ1FjwpDvfwCBdmdXC5AVKFu3e5MfNFJ29KTQT48Ob9/lqYwOGZxeUelN2U2R6+cArgtCJpauW7UQBqnFkUsjAY/kOU1cP+DAgvxwn1chZDwUbd6CFimGXwzwF6tPbFIcjEl+vvmM/byA48e6tWrKArm4ZJlCbdsrxksL1AwWn/yBSJKpYbq8AXaaTb8AAHja28jAwOC00ZrBeQNDQOWO//sdBBgYGRiYWYAEELEwMTE4uzo5Zzo5b2BxdnFOcALxNjA6b2ByTswC8jYwg0VlNuoCTWAMqNzMzsoK1rEhNqByEyerg5PMJlYuVueETKcd/89uBpnpvIEVomeHLoMsAAe1Id4AAAAAAAB42oWQT07CQBTGv0JBhagk7HQzKxca2sJCE1hDt4QF+9JOS0nbaaYDCQfwCJ7Au3AHj+LO13FMmm6cl7785vven0kBjHCBhfpYuNa5Ph1c0e2Xu3jEvWG7UdPDLZ4N92nOm+EBXuAbHmIMSRMs+4aUEd4Nd3CHD8NdvOLTsA2GL8M9PODbcL+hD7C1xoaHeLJSEao0FEW14ckxC+TU8TxvsY6X0eLPmRhry2WVioLpkrbp84LLQPGI7c6sOiUzpWIWS5GzlSgUzzLBSikOPFTOXqly7rqx0Z1Q5BAIoZBSFihQYQOOBEdkCOgXTOHA07HAGjGWiIjaPZNW13/+lm6S9FT7rLHFJ6fQbkATOG1j2OFMucKJJsxIVfQORl+9Jyda6Sl1dUYhSCm1dyClfoeDve4qMYdLEbfqHf3O/AdDumsjAAB42mNgYoAAZQYjBmyAGYQZmdhL8zLdDEydARfoAqIAAAABAAMABwAKABMAB///AA8AAQAAAAAAAAAAAAAAAAABAAAAAA==) format('woff');
4
+ }
5
+
6
+ .markdown-body {
7
+ -webkit-text-size-adjust: 100%;
8
+ text-size-adjust: 100%;
9
+ color: #333;
10
+ font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
11
+ font-size: 16px;
12
+ line-height: 1.6;
13
+ word-wrap: break-word;
14
+ }
15
+
16
+ .markdown-body a {
17
+ background-color: transparent;
18
+ }
19
+
20
+ .markdown-body a:active,
21
+ .markdown-body a:hover {
22
+ outline: 0;
23
+ }
24
+
25
+ .markdown-body strong {
26
+ font-weight: bold;
27
+ }
28
+
29
+ .markdown-body h1 {
30
+ font-size: 2em;
31
+ margin: 0.67em 0;
32
+ }
33
+
34
+ .markdown-body img {
35
+ border: 0;
36
+ }
37
+
38
+ .markdown-body hr {
39
+ box-sizing: content-box;
40
+ height: 0;
41
+ }
42
+
43
+ .markdown-body pre {
44
+ overflow: auto;
45
+ }
46
+
47
+ .markdown-body code,
48
+ .markdown-body kbd,
49
+ .markdown-body pre {
50
+ font-family: monospace, monospace;
51
+ font-size: 1em;
52
+ }
53
+
54
+ .markdown-body input {
55
+ color: inherit;
56
+ font: inherit;
57
+ margin: 0;
58
+ }
59
+
60
+ .markdown-body html input[disabled] {
61
+ cursor: default;
62
+ }
63
+
64
+ .markdown-body input {
65
+ line-height: normal;
66
+ }
67
+
68
+ .markdown-body input[type="checkbox"] {
69
+ box-sizing: border-box;
70
+ padding: 0;
71
+ }
72
+
73
+ .markdown-body table {
74
+ border-collapse: collapse;
75
+ border-spacing: 0;
76
+ }
77
+
78
+ .markdown-body td,
79
+ .markdown-body th {
80
+ padding: 0;
81
+ }
82
+
83
+ .markdown-body * {
84
+ box-sizing: border-box;
85
+ }
86
+
87
+ .markdown-body input {
88
+ font: 13px / 1.4 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
89
+ }
90
+
91
+ .markdown-body a {
92
+ color: #4078c0;
93
+ text-decoration: none;
94
+ }
95
+
96
+ .markdown-body a:hover,
97
+ .markdown-body a:active {
98
+ text-decoration: underline;
99
+ }
100
+
101
+ .markdown-body hr {
102
+ height: 0;
103
+ margin: 15px 0;
104
+ overflow: hidden;
105
+ background: transparent;
106
+ border: 0;
107
+ border-bottom: 1px solid #ddd;
108
+ }
109
+
110
+ .markdown-body hr:before {
111
+ display: table;
112
+ content: "";
113
+ }
114
+
115
+ .markdown-body hr:after {
116
+ display: table;
117
+ clear: both;
118
+ content: "";
119
+ }
120
+
121
+ .markdown-body h1,
122
+ .markdown-body h2,
123
+ .markdown-body h3,
124
+ .markdown-body h4,
125
+ .markdown-body h5,
126
+ .markdown-body h6 {
127
+ margin-top: 15px;
128
+ margin-bottom: 15px;
129
+ line-height: 1.1;
130
+ }
131
+
132
+ .markdown-body h1 {
133
+ font-size: 30px;
134
+ }
135
+
136
+ .markdown-body h2 {
137
+ font-size: 21px;
138
+ }
139
+
140
+ .markdown-body h3 {
141
+ font-size: 16px;
142
+ }
143
+
144
+ .markdown-body h4 {
145
+ font-size: 14px;
146
+ }
147
+
148
+ .markdown-body h5 {
149
+ font-size: 12px;
150
+ }
151
+
152
+ .markdown-body h6 {
153
+ font-size: 11px;
154
+ }
155
+
156
+ .markdown-body blockquote {
157
+ margin: 0;
158
+ }
159
+
160
+ .markdown-body ul,
161
+ .markdown-body ol {
162
+ padding: 0;
163
+ margin-top: 0;
164
+ margin-bottom: 0;
165
+ }
166
+
167
+ .markdown-body ol ol,
168
+ .markdown-body ul ol {
169
+ list-style-type: lower-roman;
170
+ }
171
+
172
+ .markdown-body ul ul ol,
173
+ .markdown-body ul ol ol,
174
+ .markdown-body ol ul ol,
175
+ .markdown-body ol ol ol {
176
+ list-style-type: lower-alpha;
177
+ }
178
+
179
+ .markdown-body dd {
180
+ margin-left: 0;
181
+ }
182
+
183
+ .markdown-body code {
184
+ font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
185
+ font-size: 12px;
186
+ }
187
+
188
+ .markdown-body pre {
189
+ margin-top: 0;
190
+ margin-bottom: 0;
191
+ font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
192
+ }
193
+
194
+ .markdown-body .select::-ms-expand {
195
+ opacity: 0;
196
+ }
197
+
198
+ .markdown-body .octicon {
199
+ font: normal normal normal 16px/1 octicons-link;
200
+ display: inline-block;
201
+ text-decoration: none;
202
+ text-rendering: auto;
203
+ -webkit-font-smoothing: antialiased;
204
+ -moz-osx-font-smoothing: grayscale;
205
+ -webkit-user-select: none;
206
+ -moz-user-select: none;
207
+ -ms-user-select: none;
208
+ user-select: none;
209
+ }
210
+
211
+ .markdown-body .octicon-link:before {
212
+ content: '\f05c';
213
+ }
214
+
215
+ .markdown-body:before {
216
+ display: table;
217
+ content: "";
218
+ }
219
+
220
+ .markdown-body:after {
221
+ display: table;
222
+ clear: both;
223
+ content: "";
224
+ }
225
+
226
+ .markdown-body>*:first-child {
227
+ margin-top: 0 !important;
228
+ }
229
+
230
+ .markdown-body>*:last-child {
231
+ margin-bottom: 0 !important;
232
+ }
233
+
234
+ .markdown-body a:not([href]) {
235
+ color: inherit;
236
+ text-decoration: none;
237
+ }
238
+
239
+ .markdown-body .anchor {
240
+ display: inline-block;
241
+ padding-right: 2px;
242
+ margin-left: -18px;
243
+ }
244
+
245
+ .markdown-body .anchor:focus {
246
+ outline: none;
247
+ }
248
+
249
+ .markdown-body h1,
250
+ .markdown-body h2,
251
+ .markdown-body h3,
252
+ .markdown-body h4,
253
+ .markdown-body h5,
254
+ .markdown-body h6 {
255
+ margin-top: 1em;
256
+ margin-bottom: 16px;
257
+ font-weight: bold;
258
+ line-height: 1.4;
259
+ }
260
+
261
+ .markdown-body h1 .octicon-link,
262
+ .markdown-body h2 .octicon-link,
263
+ .markdown-body h3 .octicon-link,
264
+ .markdown-body h4 .octicon-link,
265
+ .markdown-body h5 .octicon-link,
266
+ .markdown-body h6 .octicon-link {
267
+ color: #000;
268
+ vertical-align: middle;
269
+ visibility: hidden;
270
+ }
271
+
272
+ .markdown-body h1:hover .anchor,
273
+ .markdown-body h2:hover .anchor,
274
+ .markdown-body h3:hover .anchor,
275
+ .markdown-body h4:hover .anchor,
276
+ .markdown-body h5:hover .anchor,
277
+ .markdown-body h6:hover .anchor {
278
+ text-decoration: none;
279
+ }
280
+
281
+ .markdown-body h1:hover .anchor .octicon-link,
282
+ .markdown-body h2:hover .anchor .octicon-link,
283
+ .markdown-body h3:hover .anchor .octicon-link,
284
+ .markdown-body h4:hover .anchor .octicon-link,
285
+ .markdown-body h5:hover .anchor .octicon-link,
286
+ .markdown-body h6:hover .anchor .octicon-link {
287
+ visibility: visible;
288
+ }
289
+
290
+ .markdown-body h1 {
291
+ padding-bottom: 0.3em;
292
+ font-size: 2.25em;
293
+ line-height: 1.2;
294
+ border-bottom: 1px solid #eee;
295
+ }
296
+
297
+ .markdown-body h1 .anchor {
298
+ line-height: 1;
299
+ }
300
+
301
+ .markdown-body h2 {
302
+ padding-bottom: 0.3em;
303
+ font-size: 1.75em;
304
+ line-height: 1.225;
305
+ border-bottom: 1px solid #eee;
306
+ }
307
+
308
+ .markdown-body h2 .anchor {
309
+ line-height: 1;
310
+ }
311
+
312
+ .markdown-body h3 {
313
+ font-size: 1.5em;
314
+ line-height: 1.43;
315
+ }
316
+
317
+ .markdown-body h3 .anchor {
318
+ line-height: 1.2;
319
+ }
320
+
321
+ .markdown-body h4 {
322
+ font-size: 1.25em;
323
+ }
324
+
325
+ .markdown-body h4 .anchor {
326
+ line-height: 1.2;
327
+ }
328
+
329
+ .markdown-body h5 {
330
+ font-size: 1em;
331
+ }
332
+
333
+ .markdown-body h5 .anchor {
334
+ line-height: 1.1;
335
+ }
336
+
337
+ .markdown-body h6 {
338
+ font-size: 1em;
339
+ color: #777;
340
+ }
341
+
342
+ .markdown-body h6 .anchor {
343
+ line-height: 1.1;
344
+ }
345
+
346
+ .markdown-body p,
347
+ .markdown-body blockquote,
348
+ .markdown-body ul,
349
+ .markdown-body ol,
350
+ .markdown-body dl,
351
+ .markdown-body table,
352
+ .markdown-body pre {
353
+ margin-top: 0;
354
+ margin-bottom: 16px;
355
+ }
356
+
357
+ .markdown-body hr {
358
+ height: 4px;
359
+ padding: 0;
360
+ margin: 16px 0;
361
+ background-color: #e7e7e7;
362
+ border: 0 none;
363
+ }
364
+
365
+ .markdown-body ul,
366
+ .markdown-body ol {
367
+ padding-left: 2em;
368
+ }
369
+
370
+ .markdown-body ul ul,
371
+ .markdown-body ul ol,
372
+ .markdown-body ol ol,
373
+ .markdown-body ol ul {
374
+ margin-top: 0;
375
+ margin-bottom: 0;
376
+ }
377
+
378
+ .markdown-body li>p {
379
+ margin-top: 16px;
380
+ }
381
+
382
+ .markdown-body dl {
383
+ padding: 0;
384
+ }
385
+
386
+ .markdown-body dl dt {
387
+ padding: 0;
388
+ margin-top: 16px;
389
+ font-size: 1em;
390
+ font-style: italic;
391
+ font-weight: bold;
392
+ }
393
+
394
+ .markdown-body dl dd {
395
+ padding: 0 16px;
396
+ margin-bottom: 16px;
397
+ }
398
+
399
+ .markdown-body blockquote {
400
+ padding: 0 15px;
401
+ color: #777;
402
+ border-left: 4px solid #ddd;
403
+ }
404
+
405
+ .markdown-body blockquote>:first-child {
406
+ margin-top: 0;
407
+ }
408
+
409
+ .markdown-body blockquote>:last-child {
410
+ margin-bottom: 0;
411
+ }
412
+
413
+ .markdown-body table {
414
+ display: block;
415
+ width: 100%;
416
+ overflow: auto;
417
+ word-break: normal;
418
+ word-break: keep-all;
419
+ }
420
+
421
+ .markdown-body table th {
422
+ font-weight: bold;
423
+ }
424
+
425
+ .markdown-body table th,
426
+ .markdown-body table td {
427
+ padding: 6px 13px;
428
+ border: 1px solid #ddd;
429
+ }
430
+
431
+ .markdown-body table tr {
432
+ background-color: #fff;
433
+ border-top: 1px solid #ccc;
434
+ }
435
+
436
+ .markdown-body table tr:nth-child(2n) {
437
+ background-color: #f8f8f8;
438
+ }
439
+
440
+ .markdown-body img {
441
+ max-width: 100%;
442
+ box-sizing: content-box;
443
+ background-color: #fff;
444
+ }
445
+
446
+ .markdown-body code {
447
+ padding: 0;
448
+ padding-top: 0.2em;
449
+ padding-bottom: 0.2em;
450
+ margin: 0;
451
+ font-size: 85%;
452
+ background-color: rgba(0,0,0,0.04);
453
+ border-radius: 3px;
454
+ }
455
+
456
+ .markdown-body code:before,
457
+ .markdown-body code:after {
458
+ letter-spacing: -0.2em;
459
+ content: "\00a0";
460
+ }
461
+
462
+ .markdown-body pre>code {
463
+ padding: 0;
464
+ margin: 0;
465
+ font-size: 100%;
466
+ word-break: normal;
467
+ white-space: pre;
468
+ background: transparent;
469
+ border: 0;
470
+ }
471
+
472
+ .markdown-body .highlight {
473
+ margin-bottom: 16px;
474
+ }
475
+
476
+ .markdown-body .highlight pre,
477
+ .markdown-body pre {
478
+ padding: 16px;
479
+ overflow: auto;
480
+ font-size: 85%;
481
+ line-height: 1.45;
482
+ background-color: #f7f7f7;
483
+ border-radius: 3px;
484
+ }
485
+
486
+ .markdown-body .highlight pre {
487
+ margin-bottom: 0;
488
+ word-break: normal;
489
+ }
490
+
491
+ .markdown-body pre {
492
+ word-wrap: normal;
493
+ }
494
+
495
+ .markdown-body pre code {
496
+ display: inline;
497
+ max-width: initial;
498
+ padding: 0;
499
+ margin: 0;
500
+ overflow: initial;
501
+ line-height: inherit;
502
+ word-wrap: normal;
503
+ background-color: transparent;
504
+ border: 0;
505
+ }
506
+
507
+ .markdown-body pre code:before,
508
+ .markdown-body pre code:after {
509
+ content: normal;
510
+ }
511
+
512
+ .markdown-body kbd {
513
+ display: inline-block;
514
+ padding: 3px 5px;
515
+ font-size: 11px;
516
+ line-height: 10px;
517
+ color: #555;
518
+ vertical-align: middle;
519
+ background-color: #fcfcfc;
520
+ border: solid 1px #ccc;
521
+ border-bottom-color: #bbb;
522
+ border-radius: 3px;
523
+ box-shadow: inset 0 -1px 0 #bbb;
524
+ }
525
+
526
+ .markdown-body .pl-c {
527
+ color: #969896;
528
+ }
529
+
530
+ .markdown-body .pl-c1,
531
+ .markdown-body .pl-s .pl-v {
532
+ color: #0086b3;
533
+ }
534
+
535
+ .markdown-body .pl-e,
536
+ .markdown-body .pl-en {
537
+ color: #795da3;
538
+ }
539
+
540
+ .markdown-body .pl-s .pl-s1,
541
+ .markdown-body .pl-smi {
542
+ color: #333;
543
+ }
544
+
545
+ .markdown-body .pl-ent {
546
+ color: #63a35c;
547
+ }
548
+
549
+ .markdown-body .pl-k {
550
+ color: #a71d5d;
551
+ }
552
+
553
+ .markdown-body .pl-pds,
554
+ .markdown-body .pl-s,
555
+ .markdown-body .pl-s .pl-pse .pl-s1,
556
+ .markdown-body .pl-sr,
557
+ .markdown-body .pl-sr .pl-cce,
558
+ .markdown-body .pl-sr .pl-sra,
559
+ .markdown-body .pl-sr .pl-sre {
560
+ color: #183691;
561
+ }
562
+
563
+ .markdown-body .pl-v {
564
+ color: #ed6a43;
565
+ }
566
+
567
+ .markdown-body .pl-id {
568
+ color: #b52a1d;
569
+ }
570
+
571
+ .markdown-body .pl-ii {
572
+ background-color: #b52a1d;
573
+ color: #f8f8f8;
574
+ }
575
+
576
+ .markdown-body .pl-sr .pl-cce {
577
+ color: #63a35c;
578
+ font-weight: bold;
579
+ }
580
+
581
+ .markdown-body .pl-ml {
582
+ color: #693a17;
583
+ }
584
+
585
+ .markdown-body .pl-mh,
586
+ .markdown-body .pl-mh .pl-en,
587
+ .markdown-body .pl-ms {
588
+ color: #1d3e81;
589
+ font-weight: bold;
590
+ }
591
+
592
+ .markdown-body .pl-mq {
593
+ color: #008080;
594
+ }
595
+
596
+ .markdown-body .pl-mi {
597
+ color: #333;
598
+ font-style: italic;
599
+ }
600
+
601
+ .markdown-body .pl-mb {
602
+ color: #333;
603
+ font-weight: bold;
604
+ }
605
+
606
+ .markdown-body .pl-md {
607
+ background-color: #ffecec;
608
+ color: #bd2c00;
609
+ }
610
+
611
+ .markdown-body .pl-mi1 {
612
+ background-color: #eaffea;
613
+ color: #55a532;
614
+ }
615
+
616
+ .markdown-body .pl-mdr {
617
+ color: #795da3;
618
+ font-weight: bold;
619
+ }
620
+
621
+ .markdown-body .pl-mo {
622
+ color: #1d3e81;
623
+ }
624
+
625
+ .markdown-body kbd {
626
+ display: inline-block;
627
+ padding: 3px 5px;
628
+ font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
629
+ line-height: 10px;
630
+ color: #555;
631
+ vertical-align: middle;
632
+ background-color: #fcfcfc;
633
+ border: solid 1px #ccc;
634
+ border-bottom-color: #bbb;
635
+ border-radius: 3px;
636
+ box-shadow: inset 0 -1px 0 #bbb;
637
+ }
638
+
639
+ .markdown-body .task-list-item {
640
+ list-style-type: none;
641
+ }
642
+
643
+ .markdown-body .task-list-item+.task-list-item {
644
+ margin-top: 3px;
645
+ }
646
+
647
+ .markdown-body .task-list-item input {
648
+ margin: 0 0.35em 0.25em -1.6em;
649
+ vertical-align: middle;
650
+ }
651
+
652
+ .markdown-body :checked+.radio-label {
653
+ z-index: 1;
654
+ position: relative;
655
+ border-color: #4078c0;
656
+ }