jekyll-theme-endless 0.21.1 → 0.21.2
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.
- checksums.yaml +4 -4
- data/README.adoc +118 -0
- data/lib/jekyll-theme-endless/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 37f89bf3a773cc8eac8bfbecba796388748fd9f7fc7b94f98f2f74b20de42325
|
4
|
+
data.tar.gz: ad640a51c236a919550a47939f68ed8cc0e16451ece853ceb3b95de4565566d9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 164f5aa10d6858fb0624265b818e23901cb4d8560c1d38f1bc368241d129b87db4f7a4e0a46b08463803a734da02cc27128d5d0e754469d7b180bb5d082b870f
|
7
|
+
data.tar.gz: 5b3f403b51e14e6d2907d107b8d5863725598098621a9b19e68f8dc87a091529fba6aa6da23b6585002a3abc154368038d3b0fff07c033c4e22d618afd03ae0c
|
data/README.adoc
CHANGED
@@ -99,6 +99,124 @@ The reason is, that Jekyll-AsciiDoc (in contrast to Markdown) escapes HTML by de
|
|
99
99
|
Thus, using (unescaped) HTML-commands e.g. in titles of Markdown posts/pages might break the layout.
|
100
100
|
If you want to use Markdown AND have HTML-commands in the title, simply escape them (e.g. use `\<` instead of `<`).
|
101
101
|
|
102
|
+
[[deploymentdiagram]]
|
103
|
+
.https://plantuml.com/deployment-diagram[Deployment Diagram] of this repository. The files in this repository are grouped into four categories: (*1*) files that contribute to the Ruby gem artifact, (*2*) files that contribute to the Docker image artifact, (*3*) files that contribute to the website for this theme, and (*4*) helper and configuration files (supporting development, dependency management, deployment, etc.). Files marked in *Green* should be included in your project as dependencies. Files marked in *Blue* are specific to your website (i.e., your blog content). The https://quickstart-blog.gitlab.io/[Quickstart Blog] is an example of these blue files, which you can fork to https://quickstart-blog.gitlab.io/create-jekyll-blog-in-5-minutes/[start your own blog easily]. (*++*++*) The file `_data/tag-description.yml` is not included in the gem package. (*++**++*) The `README` file and the `pages_examples` folder are both packaged in the Ruby gem and used as website content. (*++***++*) You typically want to override default values from the theme's `_config.yml`. (*++****++*) The gem is deployed manually, while the Docker image and GitLab Pages are deployed automatically during each CI pipeline run.
|
104
|
+
[plantuml, format="svg"]
|
105
|
+
....
|
106
|
+
@startuml
|
107
|
+
title Deployment diagram of this repository
|
108
|
+
top to bottom direction
|
109
|
+
|
110
|
+
'package "Repository" {
|
111
|
+
|
112
|
+
' Objects: files
|
113
|
+
' ##########################################################
|
114
|
+
frame "Files and folders of the repository" {
|
115
|
+
' It appears that the file cards need to be added in reverse order
|
116
|
+
' compared to how they should later appear in the diagram.
|
117
|
+
card helper_files #PowderBlue [
|
118
|
+
<b>(4) helper/config-files:</b>
|
119
|
+
----
|
120
|
+
' Files supporting the development
|
121
|
+
* .editorconfig
|
122
|
+
* .gitignore
|
123
|
+
....
|
124
|
+
' Files supporting the deployment
|
125
|
+
* .gitlab-ci.yml
|
126
|
+
* getversion.sh
|
127
|
+
* deploy.sh
|
128
|
+
....
|
129
|
+
' Files used for configuration and dependecy-management
|
130
|
+
* Gemfile
|
131
|
+
* Gemfile.lock
|
132
|
+
* (package.json)
|
133
|
+
....
|
134
|
+
' Screenshot for theme documentation
|
135
|
+
' https://jekyllrb.com/docs/themes/#adding-a-screenshot
|
136
|
+
* screenshot.png
|
137
|
+
* screenshot2.png
|
138
|
+
]
|
139
|
+
card content_files #PowderBlue [
|
140
|
+
<b>(3) content-files:</b>
|
141
|
+
----
|
142
|
+
* index.adoc
|
143
|
+
* README.adoc (**)
|
144
|
+
....
|
145
|
+
* _posts
|
146
|
+
* content
|
147
|
+
* pages
|
148
|
+
* pages_examples (**)
|
149
|
+
* theme-specific
|
150
|
+
....
|
151
|
+
* _config.yml (***)
|
152
|
+
* _configData.yml
|
153
|
+
* _configDocker.yml
|
154
|
+
* _data/tag-description.yml
|
155
|
+
]
|
156
|
+
card docker_files #palegreen [
|
157
|
+
<b>(2) Docker image:</b>
|
158
|
+
----
|
159
|
+
* Dockerfile
|
160
|
+
]
|
161
|
+
card theme_files #palegreen [
|
162
|
+
<b>(1) theme-files:</b>
|
163
|
+
----
|
164
|
+
* _config.yml
|
165
|
+
* jekyll-theme-endless.gemspec
|
166
|
+
* _data (*)
|
167
|
+
* _includes
|
168
|
+
* _layouts
|
169
|
+
* _sass
|
170
|
+
* assets
|
171
|
+
* lib
|
172
|
+
....
|
173
|
+
* README.adoc (**)
|
174
|
+
* pages_examples (**)
|
175
|
+
* LICENSE.txt
|
176
|
+
]
|
177
|
+
}
|
178
|
+
|
179
|
+
' Objects: deployment steps
|
180
|
+
' ##########################################################
|
181
|
+
frame "Build and deployment steps" as B_D {
|
182
|
+
process "deploy.sh (****)" as deploy_theme
|
183
|
+
frame ".gitlab-ci.yml" {
|
184
|
+
process "build-docker-image" as deploy_docker
|
185
|
+
process "deploy-to-gitlab-pages" as deploy_pages
|
186
|
+
}
|
187
|
+
}
|
188
|
+
|
189
|
+
'}
|
190
|
+
|
191
|
+
' Objects: deployment targets
|
192
|
+
' ##########################################################
|
193
|
+
cloud rubygems.org {
|
194
|
+
artifact "jekyll-theme-endless" as ruby_gem #palegreen
|
195
|
+
}
|
196
|
+
cloud "registry.gitlab.com" {
|
197
|
+
artifact "jekyll-theme-endless" as docker_image #palegreen
|
198
|
+
}
|
199
|
+
cloud "GitLab Pages" {
|
200
|
+
artifact "jekyll-theme-endless.gitlab.io" as website
|
201
|
+
}
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
' Arrows from files to deployment steps
|
206
|
+
' ##########################################################
|
207
|
+
theme_files --> deploy_theme
|
208
|
+
docker_files --> deploy_docker
|
209
|
+
content_files --> deploy_pages
|
210
|
+
|
211
|
+
' Arrows from deployment steps to deployment targets
|
212
|
+
' ##########################################################
|
213
|
+
deploy_theme --> ruby_gem
|
214
|
+
deploy_docker --> docker_image
|
215
|
+
deploy_pages --> website
|
216
|
+
|
217
|
+
@enduml
|
218
|
+
....
|
219
|
+
|
102
220
|
|
103
221
|
|
104
222
|
|