faker_maker 2.1.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby.yml +13 -14
  3. data/.rubocop.yml +3 -3
  4. data/Gemfile +4 -0
  5. data/README.md +7 -1
  6. data/faker_maker.gemspec +2 -2
  7. data/lib/faker_maker/factory.rb +2 -2
  8. data/lib/faker_maker/version.rb +1 -1
  9. data/lib/faker_maker.rb +1 -1
  10. data/usefakermaker.com/.gitignore +5 -0
  11. data/usefakermaker.com/404.html +25 -0
  12. data/usefakermaker.com/Gemfile +39 -0
  13. data/usefakermaker.com/README.md +5 -0
  14. data/usefakermaker.com/_config.yml +299 -0
  15. data/usefakermaker.com/_config.yml.orig +55 -0
  16. data/usefakermaker.com/_data/navigation.yml +51 -0
  17. data/usefakermaker.com/_data/ui-text.yml +2132 -0
  18. data/usefakermaker.com/_site/assets/css/main.css +6 -0
  19. data/usefakermaker.com/_site/assets/css/main.css.map +1 -0
  20. data/usefakermaker.com/_site/assets/js/_main.js +230 -0
  21. data/usefakermaker.com/_site/assets/js/lunr/lunr-en.js +69 -0
  22. data/usefakermaker.com/_site/assets/js/lunr/lunr-gr.js +522 -0
  23. data/usefakermaker.com/_site/assets/js/lunr/lunr-store.js +1 -0
  24. data/usefakermaker.com/_site/assets/js/lunr/lunr.js +3475 -0
  25. data/usefakermaker.com/_site/assets/js/lunr/lunr.min.js +6 -0
  26. data/usefakermaker.com/_site/assets/js/main.min.js +7 -0
  27. data/usefakermaker.com/_site/assets/js/main.min.js.map +1 -0
  28. data/usefakermaker.com/_site/assets/js/plugins/gumshoe.js +484 -0
  29. data/usefakermaker.com/_site/assets/js/plugins/jquery.ba-throttle-debounce.js +252 -0
  30. data/usefakermaker.com/_site/assets/js/plugins/jquery.fitvids.js +82 -0
  31. data/usefakermaker.com/_site/assets/js/plugins/jquery.greedy-navigation.js +128 -0
  32. data/usefakermaker.com/_site/assets/js/plugins/jquery.magnific-popup.js +1860 -0
  33. data/usefakermaker.com/_site/assets/js/plugins/smooth-scroll.js +650 -0
  34. data/usefakermaker.com/_site/assets/js/vendor/jquery/jquery-3.6.0.js +10881 -0
  35. data/usefakermaker.com/_site/feed.xml +1 -0
  36. data/usefakermaker.com/_site/robots.txt +1 -0
  37. data/usefakermaker.com/_site/sitemap.xml +3 -0
  38. data/usefakermaker.com/about.markdown +18 -0
  39. data/usefakermaker.com/assets/images/pug.png +0 -0
  40. data/usefakermaker.com/assets/images/unipug.svg +135 -0
  41. data/usefakermaker.com/docs/contributing/index.md +7 -0
  42. data/{docs/installation.md → usefakermaker.com/docs/installing/index.md} +3 -5
  43. data/{docs/usage/arrays.md → usefakermaker.com/docs/usage/arrays/index.md} +2 -6
  44. data/{docs/usage/building_instances.md → usefakermaker.com/docs/usage/building-instances/index.md} +6 -10
  45. data/{docs/usage/chaos.md → usefakermaker.com/docs/usage/chaos/index.md} +6 -10
  46. data/{docs/usage/destroying_factories.md → usefakermaker.com/docs/usage/destroying-factories/index.md} +7 -9
  47. data/{docs/usage/embedding_factories.md → usefakermaker.com/docs/usage/embedding-factories/index.md} +2 -6
  48. data/{docs/usage → usefakermaker.com/docs/usage/getting-started}/index.md +12 -15
  49. data/{docs/usage/audit_logs.md → usefakermaker.com/docs/usage/history-logging/index.md} +4 -4
  50. data/{docs/usage/inheritance.md → usefakermaker.com/docs/usage/inheritance/index.md} +7 -9
  51. data/{docs/usage/json_field_names.md → usefakermaker.com/docs/usage/json-field-names/index.md} +2 -6
  52. data/{docs/usage/lifecycle_hooks.md → usefakermaker.com/docs/usage/lifecycle-hooks/index.md} +3 -7
  53. data/{docs/usage/dependencies.md → usefakermaker.com/docs/usage/managing-dependencies/index.md} +2 -6
  54. data/{docs/usage/omitting_fields copy.md → usefakermaker.com/docs/usage/omitting-fields/index.md} +4 -8
  55. data/usefakermaker.com/pages/index.markdown +27 -0
  56. metadata +53 -30
  57. data/docs/.bundle/config +0 -2
  58. data/docs/.keep +0 -1
  59. data/docs/_config.yml +0 -8
  60. data/docs/contributing.md +0 -9
  61. data/docs/credits.md +0 -9
  62. data/docs/index.md +0 -21
  63. data/docs/logo.png +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fcfd81c4277ef4cbf713d092554e472e7b3a0dfafeff3e4f03f4237f1dafff5f
4
- data.tar.gz: 44fef577fffec88b8dd1443dd3cc69478ca54100739381f1f8a2a74adb23ee50
3
+ metadata.gz: e6d677fff1380c1eddf6c0305b978d8b161d0f5fbb5e1752bc587a0dc10e8554
4
+ data.tar.gz: 7df7f5f9279c2e745842999117672e608b9d1e2302d63bcae9914429f796491a
5
5
  SHA512:
6
- metadata.gz: 067b5f673a1e0ebd33d48c62f327197d889fe995ad847e9ba2d4b85b5ffc0442a723698b2b19f75abee52d9a32ac3d6f5c98301fdef2d398c2ef197fccd74e2b
7
- data.tar.gz: 5ddb1d3c400e6d67f4cd29443704b2e185ae40a5a8881b89adb307a1f4d81488afc35801245d882b3ceac61b58bd1fc406288d972e6f468eb92712a780adcff9
6
+ metadata.gz: fe8ae2a8550b5eaf9a78eaf2bda1ab8f7f1eac1f1f557223e744111bf45ee417c5a9215aa1cd2dae5e23d90a1b3b9aa347a2bba52a5d97d7d8f53f91fd629196
7
+ data.tar.gz: 19290557db759839023a0a7b80b9cd2bf9f01e652a7e610f5f5cfd9f037459f2be04cc51a34eed271dead74289f9001fd15aebbf8913355e55c5004a7b466f31
@@ -10,28 +10,27 @@ name: Ruby
10
10
  on:
11
11
  push:
12
12
  pull_request:
13
- branches: [ "master" ]
13
+ branches: ["master"]
14
14
 
15
15
  permissions:
16
16
  contents: read
17
17
 
18
18
  jobs:
19
19
  test:
20
-
21
20
  runs-on: ubuntu-latest
22
21
  strategy:
23
22
  matrix:
24
- ruby-version: ["3.0", "3.1", "3.2"]
23
+ ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4"]
25
24
 
26
25
  steps:
27
- - uses: actions/checkout@v3
28
- - name: Set up Ruby
29
- # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
30
- # change this to (see https://github.com/ruby/setup-ruby#versioning):
31
- # uses: ruby/setup-ruby@v1
32
- uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
33
- with:
34
- ruby-version: ${{ matrix.ruby-version }}
35
- bundler-cache: true # runs 'bundle install' and caches installed gems automatically
36
- - name: Run tests
37
- run: bundle exec rake
26
+ - uses: actions/checkout@v3
27
+ - name: Set up Ruby
28
+ # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
29
+ # change this to (see https://github.com/ruby/setup-ruby#versioning):
30
+ # uses: ruby/setup-ruby@v1
31
+ uses: ruby/setup-ruby@v1 # v1.146.0
32
+ with:
33
+ ruby-version: ${{ matrix.ruby-version }}
34
+ bundler-cache: true # runs 'bundle install' and caches installed gems automatically
35
+ - name: Run tests
36
+ run: bundle exec rake
data/.rubocop.yml CHANGED
@@ -1,7 +1,7 @@
1
1
  Layout/SpaceInsideParens:
2
2
  Enabled: false
3
3
 
4
- Metrics/LineLength:
4
+ Layout/LineLength:
5
5
  Max: 120
6
6
 
7
7
  Metrics/ModuleLength:
@@ -32,7 +32,7 @@ Style/HashEachMethods:
32
32
 
33
33
  Style/HashTransformKeys:
34
34
  Enabled: true
35
-
35
+
36
36
  Style/HashTransformValues:
37
37
  Enabled: true
38
38
 
@@ -52,4 +52,4 @@ Metrics/PerceivedComplexity:
52
52
  Max: 10
53
53
 
54
54
  AllCops:
55
- NewCops: enable
55
+ NewCops: enable
data/Gemfile CHANGED
@@ -6,3 +6,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
6
6
 
7
7
  # Specify your gem's dependencies in faker_maker.gemspec
8
8
  gemspec
9
+
10
+ gem 'bundler-audit', '~> 0.9.2'
11
+ gem 'irb', '~> 1.15'
12
+ gem 'rdoc', '~> 6.13'
data/README.md CHANGED
@@ -21,4 +21,10 @@
21
21
 
22
22
  FakerMaker is a simple factory builder so you can throw away your fixtures and generate test data instead.
23
23
 
24
- Read the [documentation here](https://billyruffian.github.io/faker_maker/).
24
+ Sometimes you need generate data; something testers need to do a lot. Often, a bunch of fixtures will be built by hand, carefully maintained and curated, until the API or schema or something changes and all the fixtures need to be pruned before the tests pass again. This drives testers into building fixtures which individually cover lots of acceptance critera just so that they can drive down the number of them they have to maintain until the fixtures don’t resemble anything like realistic criteria.
25
+
26
+ If you’re testing a Rails application, you can use the awesome FactoryBot to generate faked model instances but what if you’re not using Rails or you don’t have model classes or you’re testing an API? This is what Faker Maker aims to help with.
27
+
28
+ It is designed to resemble the Factory Bot gem but without needing an existing class definition to back its object and so it goes without saying that it offers no persistence mechanism. Its purpose is to provide a simple framework for generating data to test JSON APIs and is intended to be used with the Faker gem (but has no dependency upon it).
29
+
30
+ Read the [documentation here](https://usefakermaker.com).
data/faker_maker.gemspec CHANGED
@@ -41,9 +41,9 @@ Gem::Specification.new do |spec|
41
41
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
42
42
  spec.require_paths = ['lib']
43
43
 
44
- spec.add_dependency 'activesupport', '>= 5.2', '< 8'
44
+ spec.add_dependency 'activesupport', '>= 5.2', '< 9'
45
45
 
46
- spec.add_development_dependency 'bundler', '~> 2.0'
46
+ spec.add_development_dependency 'bundler', '~> 2'
47
47
  spec.add_development_dependency 'faker', '~> 3.2'
48
48
  spec.add_development_dependency 'guard', '~> 2.16'
49
49
  spec.add_development_dependency 'guard-bundler', '~> 3.0'
@@ -28,7 +28,7 @@ module FakerMaker
28
28
 
29
29
  def parent_class
30
30
  if @parent
31
- Object.const_get( FakerMaker[@parent].class_name )
31
+ FakerMaker::Factory.const_get( FakerMaker[@parent].class_name )
32
32
  else
33
33
  Object
34
34
  end
@@ -67,7 +67,7 @@ module FakerMaker
67
67
  def assemble
68
68
  if @klass.nil?
69
69
  @klass = Class.new parent_class
70
- Object.const_set @class_name, @klass
70
+ FakerMaker::Factory.const_set @class_name, @klass
71
71
  attach_attributes_to_class
72
72
  attach_json_overrides_to_class
73
73
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module FakerMaker
4
- VERSION = '2.1.1'
4
+ VERSION = '3.0.0'
5
5
  end
data/lib/faker_maker.rb CHANGED
@@ -63,7 +63,7 @@ module FakerMaker
63
63
  return unless factory
64
64
 
65
65
  factories[name] = nil
66
- Object.send( :remove_const, factory.class_name )
66
+ FakerMaker::Factory.send( :remove_const, factory.class_name )
67
67
  end
68
68
 
69
69
  def shut_all!
@@ -0,0 +1,5 @@
1
+ _site
2
+ .sass-cache
3
+ .jekyll-cache
4
+ .jekyll-metadata
5
+ vendor
@@ -0,0 +1,25 @@
1
+ ---
2
+ permalink: /404.html
3
+ layout: default
4
+ ---
5
+
6
+ <style type="text/css" media="screen">
7
+ .container {
8
+ margin: 10px auto;
9
+ max-width: 600px;
10
+ text-align: center;
11
+ }
12
+ h1 {
13
+ margin: 30px 0;
14
+ font-size: 4em;
15
+ line-height: 1;
16
+ letter-spacing: -1px;
17
+ }
18
+ </style>
19
+
20
+ <div class="container">
21
+ <h1>404</h1>
22
+
23
+ <p><strong>Page not found :(</strong></p>
24
+ <p>The requested page could not be found.</p>
25
+ </div>
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+ # Hello! This is where you manage which Jekyll version is used to run.
5
+ # When you want to use a different version, change it below, save the
6
+ # file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
7
+ #
8
+ # bundle exec jekyll serve
9
+ #
10
+ # This will help ensure the proper Jekyll version is running.
11
+ # Happy Jekylling!
12
+ gem 'jekyll', '~> 4.3.4'
13
+ # This is the default theme for new Jekyll sites. You may change this to anything you like.
14
+ gem 'minima', '~> 2.5'
15
+ # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
16
+ # uncomment the line below. To upgrade, run `bundle update github-pages`.
17
+ # gem "github-pages", group: :jekyll_plugins
18
+ # If you have any plugins, put them here!
19
+ group :jekyll_plugins do
20
+ gem 'jekyll-data'
21
+ gem 'jekyll-feed', '~> 0.12'
22
+ end
23
+
24
+ # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
25
+ # and associated library.
26
+ platforms :mingw, :x64_mingw, :mswin, :jruby do
27
+ gem 'tzinfo', '>= 1', '< 3'
28
+ gem 'tzinfo-data'
29
+ end
30
+
31
+ # Performance-booster for watching directories on Windows
32
+ gem 'wdm', '~> 0.1', platforms: %i[mingw x64_mingw mswin]
33
+
34
+ # Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
35
+ # do not have a Java counterpart.
36
+ gem 'base64'
37
+ gem 'csv'
38
+ gem 'http_parser.rb', '~> 0.6.0', platforms: [:jruby]
39
+ gem 'minimal-mistakes-jekyll'
@@ -0,0 +1,5 @@
1
+ This is the Jekyll documentation for Faker Maker.
2
+
3
+ Cloudflare Pages is configurated to automatically deploy the `main` branch of this repository to the `usefakermaker.com` domain.
4
+
5
+ When adding pages, you usually want to add to the `usage` collection. Remember to update the `data/_navigation.yml` file to include the new page in the navigation.
@@ -0,0 +1,299 @@
1
+ # Welcome to Jekyll!
2
+ #
3
+ # This config file is meant for settings that affect your whole blog, values
4
+ # which you are expected to set up once and rarely edit after that. If you find
5
+ # yourself editing this file very often, consider using Jekyll's data files
6
+ # feature for the data you need to update frequently.
7
+ #
8
+ # For technical reasons, this file is *NOT* reloaded automatically when you use
9
+ # 'bundle exec jekyll serve'. If you change this file, please restart the server process.
10
+ #
11
+ # If you need help with YAML syntax, here are some quick references for you:
12
+ # https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
13
+ # https://learnxinyminutes.com/docs/yaml/
14
+ #
15
+ # Site settings
16
+ # These are used to personalize your new site. If you look in the HTML files,
17
+ # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
18
+ # You can create any custom variable you would like, and they will be accessible
19
+ # in the templates via {{ site.myvariable }}.
20
+
21
+ title: Faker Maker
22
+ email: hello@billy-ruffian.co.uk
23
+ description: >- # this means to ignore newlines until "baseurl:"
24
+ Factories over fixtures: cook your test data from fresh
25
+ baseurl: "" # the subpath of your site, e.g. /blog
26
+ url: "https://www.usefakermaker.com" # the base hostname & protocol for your site, e.g. http://example.com
27
+ twitter_username: thebillyruffian
28
+ github_username: BillyRuffian
29
+
30
+ include: ["pages", "docs"]
31
+
32
+ # Build settings
33
+ theme: minimal-mistakes-jekyll
34
+ plugins:
35
+ - jekyll-feed
36
+ - jekyll-include-cache
37
+ - jekyll-paginate
38
+ - jekyll-sitemap
39
+ - jekyll-gist
40
+ - jekyll-data
41
+
42
+ # Exclude from processing.
43
+ # The following items will not be processed, by default.
44
+ # Any item listed under the `exclude:` key here will be automatically added to
45
+ # the internal "default list".
46
+ #
47
+ # Excluded items can be processed by explicitly listing the directories or
48
+ # their entries' file path in the `include:` list.
49
+ #
50
+ # exclude:
51
+ # - .sass-cache/
52
+ # - .jekyll-cache/
53
+ # - gemfiles/
54
+ # - Gemfile
55
+ # - Gemfile.lock
56
+ # - node_modules/
57
+ # - vendor/bundle/
58
+ # - vendor/cache/
59
+ # - vendor/gems/
60
+ # - vendor/ruby/
61
+
62
+ minimal_mistakes_skin: "sunrise" #"default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
63
+
64
+ # Site Settings
65
+ locale: "en-GB"
66
+ rtl: # true, false (default) # turns direction of the page into right to left for RTL languages
67
+ title_separator: "-"
68
+ subtitle: "Factories over fixtures" # site tagline that appears below site title in masthead
69
+ name: "Nigel Brookes-Thomas"
70
+ repository: # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
71
+ teaser: # path of fallback teaser image, e.g. "/assets/images/500x300.png"
72
+ logo: "/assets/images/unipug.svg" # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png"
73
+ masthead_title: # overrides the website title displayed in the masthead, use " " for no title
74
+ breadcrumbs: # true, false (default)
75
+ words_per_minute: 200
76
+ enable_copy_code_button: true # true, false (default)
77
+ copyright: Nigel Brookes-Thomas # "copyright" name, defaults to site.title
78
+ copyright_url: # "copyright" URL, defaults to site.url
79
+ comments:
80
+ provider: # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "giscus", "custom"
81
+ disqus:
82
+ shortname: # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname-
83
+ discourse:
84
+ server: # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org
85
+ facebook:
86
+ # https://developers.facebook.com/docs/plugins/comments
87
+ appid:
88
+ num_posts: # 5 (default)
89
+ colorscheme: # "light" (default), "dark"
90
+ utterances:
91
+ theme: # "github-light" (default), "github-dark"
92
+ issue_term: # "pathname" (default)
93
+ giscus:
94
+ repo_id: # Shown during giscus setup at https://giscus.app
95
+ category_name: # Full text name of the category
96
+ category_id: # Shown during giscus setup at https://giscus.app
97
+ discussion_term: # "pathname" (default), "url", "title", "og:title"
98
+ reactions_enabled: # '1' for enabled (default), '0' for disabled
99
+ theme: # "light" (default), "dark", "dark_dimmed", "transparent_dark", "preferred_color_scheme"
100
+ strict: # 1 for enabled, 0 for disabled (default)
101
+ input_position: # "top", "bottom" # The comment input box will be placed above or below the comments
102
+ emit_metadata: # 1 for enabled, 0 for disabled (default) # https://github.com/giscus/giscus/blob/main/ADVANCED-USAGE.md#imetadatamessage
103
+ lang: # "en" (default)
104
+ lazy: # true, false # Loading of the comments will be deferred until the user scrolls near the comments container.
105
+ staticman:
106
+ branch: # "master"
107
+ endpoint: # "https://{your Staticman v3 API}/v3/entry/github/"
108
+ reCaptcha:
109
+ siteKey:
110
+ secret:
111
+ atom_feed:
112
+ path: # blank (default) uses feed.xml
113
+ hide: true # true, false (default)
114
+ search: true # true, false (default)
115
+ search_full_content: true # true, false (default)
116
+ search_provider: # lunr (default), algolia, google
117
+ lunr:
118
+ search_within_pages: true # true, false (default)
119
+ algolia:
120
+ application_id: # YOUR_APPLICATION_ID
121
+ index_name: # YOUR_INDEX_NAME
122
+ search_only_api_key: # YOUR_SEARCH_ONLY_API_KEY
123
+ powered_by: # true (default), false
124
+ google:
125
+ search_engine_id: # YOUR_SEARCH_ENGINE_ID
126
+ instant_search: # false (default), true
127
+ # SEO Related
128
+ google_site_verification:
129
+ bing_site_verification:
130
+ naver_site_verification:
131
+ yandex_site_verification:
132
+ baidu_site_verification:
133
+
134
+ # Site Author
135
+ author:
136
+ name: "Nigel Brookes-Thomas (Billy Ruffian)"
137
+ avatar: "/assets/images/pug.png"
138
+ bio: "I test things and write ruby things."
139
+ location: "UK"
140
+ email:
141
+ links:
142
+ # - label: "Email"
143
+ # icon: "fas fa-fw fa-envelope-square"
144
+ # # url: "mailto:your.name@email.com"
145
+ - label: "Website"
146
+ icon: "fas fa-fw fa-link"
147
+ url: "https://www.billy-ruffian.co.uk"
148
+ # - label: "Twitter"
149
+ # icon: "fab fa-fw fa-twitter-square"
150
+ # # url: "https://twitter.com/"
151
+ # - label: "Facebook"
152
+ # icon: "fab fa-fw fa-facebook-square"
153
+ # # url: "https://facebook.com/"
154
+ - label: "GitHub"
155
+ icon: "fab fa-fw fa-github"
156
+ url: "https://github.com/BillyRuffian"
157
+ # - label: "Instagram"
158
+ # icon: "fab fa-fw fa-instagram"
159
+ # url: "https://instagram.com/"
160
+
161
+ # Site Footer
162
+ footer:
163
+ links:
164
+ # - label: "Twitter"
165
+ # icon: "fab fa-fw fa-twitter-square"
166
+ # # url:
167
+ # - label: "Facebook"
168
+ # icon: "fab fa-fw fa-facebook-square"
169
+ # # url:
170
+
171
+ - label: "GitHub"
172
+ icon: "fab fa-fw fa-github"
173
+ url: https://github.com/BillyRuffian/faker_maker
174
+ # - label: "GitLab"
175
+ # icon: "fab fa-fw fa-gitlab"
176
+ # # url:
177
+ # - label: "Bitbucket"
178
+ # icon: "fab fa-fw fa-bitbucket"
179
+ # # url:
180
+ # - label: "Instagram"
181
+ # icon: "fab fa-fw fa-instagram"
182
+ # # url:
183
+
184
+ # Conversion
185
+ markdown: kramdown
186
+ highlighter: rouge
187
+ lsi: false
188
+ excerpt_separator: "\n\n"
189
+ incremental: false
190
+
191
+ # Markdown Processing
192
+ kramdown:
193
+ input: GFM
194
+ hard_wrap: false
195
+ auto_ids: true
196
+ footnote_nr: 1
197
+ entity_output: as_char
198
+ toc_levels: 1..6
199
+ smart_quotes: lsquo,rsquo,ldquo,rdquo
200
+ enable_coderay: false
201
+
202
+ # Sass/SCSS
203
+ sass:
204
+ sass_dir: _sass
205
+ style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
206
+
207
+ # Outputting
208
+ permalink: /:categories/:title/
209
+ timezone: # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
210
+
211
+ # Pagination with jekyll-paginate
212
+ paginate: 5 # amount of posts to show
213
+ paginate_path: /page:num/
214
+
215
+ # Pagination with jekyll-paginate-v2
216
+ # See https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#site-configuration
217
+ # for configuration details
218
+ pagination:
219
+ # Set enabled to true to use paginate v2
220
+ enabled: false
221
+ debug: false
222
+ collection: "posts"
223
+ per_page: 10
224
+ permalink: "/page/:num/"
225
+ title: ":title - page :num"
226
+ limit: 0
227
+ sort_field: "date"
228
+ sort_reverse: true
229
+ category: "posts"
230
+ tag: ""
231
+ locale: ""
232
+ trail:
233
+ before: 2
234
+ after: 2
235
+
236
+ # mimic GitHub Pages with --safe
237
+ whitelist:
238
+ - jekyll-paginate
239
+ - jekyll-sitemap
240
+ - jekyll-gist
241
+ - jekyll-feed
242
+ - jekyll-include-cache
243
+
244
+ # Archives
245
+ # Type
246
+ # - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default)
247
+ # - Jekyll Archives plugin archive pages ~> type: jekyll-archives
248
+ # Path (examples)
249
+ # - Archive page should exist at path when using Liquid method or you can
250
+ # expect broken links (especially with breadcrumbs enabled)
251
+ # - <base_path>/tags/my-awesome-tag/index.html ~> path: /tags/
252
+ # - <base_path>/categories/my-awesome-category/index.html ~> path: /categories/
253
+ # - <base_path>/my-awesome-category/index.html ~> path: /
254
+ category_archive:
255
+ type: liquid
256
+ path: /categories/
257
+ tag_archive:
258
+ type: liquid
259
+ path: /tags/
260
+ # https://github.com/jekyll/jekyll-archives
261
+ # jekyll-archives:
262
+ # enabled:
263
+ # - categories
264
+ # - tags
265
+ # layouts:
266
+ # category: archive-taxonomy
267
+ # tag: archive-taxonomy
268
+ # permalinks:
269
+ # category: /categories/:name/
270
+ # tag: /tags/:name/
271
+
272
+ # HTML Compression
273
+ # - https://jch.penibelst.de/
274
+ compress_html:
275
+ clippings: all
276
+ ignore:
277
+ envs: development
278
+
279
+ # Defaults
280
+ defaults:
281
+ # _posts
282
+ - scope:
283
+ path: ""
284
+ type: posts
285
+ values:
286
+ layout: single
287
+ author_profile: false
288
+ read_time: false
289
+ comments: # true
290
+ share: false
291
+ related: false
292
+ - scope:
293
+ path: "docs"
294
+ type: pages
295
+ values:
296
+ layout: single
297
+ author_profile: false
298
+ sidebar:
299
+ nav: "sidebar"
@@ -0,0 +1,55 @@
1
+ # Welcome to Jekyll!
2
+ #
3
+ # This config file is meant for settings that affect your whole blog, values
4
+ # which you are expected to set up once and rarely edit after that. If you find
5
+ # yourself editing this file very often, consider using Jekyll's data files
6
+ # feature for the data you need to update frequently.
7
+ #
8
+ # For technical reasons, this file is *NOT* reloaded automatically when you use
9
+ # 'bundle exec jekyll serve'. If you change this file, please restart the server process.
10
+ #
11
+ # If you need help with YAML syntax, here are some quick references for you:
12
+ # https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
13
+ # https://learnxinyminutes.com/docs/yaml/
14
+ #
15
+ # Site settings
16
+ # These are used to personalize your new site. If you look in the HTML files,
17
+ # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
18
+ # You can create any custom variable you would like, and they will be accessible
19
+ # in the templates via {{ site.myvariable }}.
20
+
21
+ title: Your awesome title
22
+ email: your-email@example.com
23
+ description: >- # this means to ignore newlines until "baseurl:"
24
+ Write an awesome description for your new site here. You can edit this
25
+ line in _config.yml. It will appear in your document head meta (for
26
+ Google search results) and in your feed.xml site description.
27
+ baseurl: "" # the subpath of your site, e.g. /blog
28
+ url: "" # the base hostname & protocol for your site, e.g. http://example.com
29
+ twitter_username: jekyllrb
30
+ github_username: jekyll
31
+
32
+ # Build settings
33
+ theme: minima
34
+ plugins:
35
+ - jekyll-feed
36
+
37
+ # Exclude from processing.
38
+ # The following items will not be processed, by default.
39
+ # Any item listed under the `exclude:` key here will be automatically added to
40
+ # the internal "default list".
41
+ #
42
+ # Excluded items can be processed by explicitly listing the directories or
43
+ # their entries' file path in the `include:` list.
44
+ #
45
+ # exclude:
46
+ # - .sass-cache/
47
+ # - .jekyll-cache/
48
+ # - gemfiles/
49
+ # - Gemfile
50
+ # - Gemfile.lock
51
+ # - node_modules/
52
+ # - vendor/bundle/
53
+ # - vendor/cache/
54
+ # - vendor/gems/
55
+ # - vendor/ruby/
@@ -0,0 +1,51 @@
1
+ # main links
2
+ main:
3
+ # - title: "Quick-Start Guide"
4
+ # url: https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/
5
+ - title: "Documentation"
6
+ url: /docs/installing/
7
+ - title: "About"
8
+ url: /pages/about/
9
+ # - title: "About"
10
+ # url: https://mmistakes.github.io/minimal-mistakes/about/
11
+ # - title: "Sample Posts"
12
+ # url: /year-archive/
13
+ # - title: "Sample Collections"
14
+ # url: /collection-archive/
15
+ # - title: "Sitemap"
16
+ # url: /sitemap/
17
+
18
+ sidebar:
19
+ - title: "Getting started"
20
+ children:
21
+ - title: "Installing"
22
+ url: /docs/installing/
23
+ - title: "Contributing"
24
+ url: /docs/contributing/
25
+
26
+ - title: "Usage"
27
+ children:
28
+ - title: "Getting started"
29
+ url: /docs/usage/getting-started/
30
+ - title: "Building instances"
31
+ url: /docs/usage/building-instances/
32
+ - title: "Arrays"
33
+ url: /docs/usage/arrays/
34
+ - title: "Omitting fields"
35
+ url: /docs/usage/omitting-fields/
36
+ - title: "JSON field names"
37
+ url: /docs/usage/json-field-names/
38
+ - title: "Inheritance"
39
+ url: /docs/usage/inheritance/
40
+ - title: "Embedding factories"
41
+ url: /docs/usage/embedding-factories/
42
+ - title: "Chaos"
43
+ url: /docs/usage/chaos/
44
+ - title: "Lifecycle hooks"
45
+ url: /docs/usage/lifecycle-hooks/
46
+ - title: "Destroying factories"
47
+ url: /docs/usage/destroying-factories/
48
+ - title: "Managing dependencies"
49
+ url: /docs/usage/managing-dependencies/
50
+ - title: "History logging"
51
+ url: /docs/usage/history-logging/