Skip to content

Commit c27152a

Browse files
vncoelhovncoelho
committed
OptFrame docs and portal with Jekyll
0 parents  commit c27152a

30 files changed

+2102
-0
lines changed

‎.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
_site
2+
.sass-cache
3+
.jekyll-metadata
4+
Gemfile.lock
5+
Gemfile
6+
_config-temp.yml

‎Gemfile-local-backup

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
source "https://rubygems.org"
2+
3+
# Used for local tests
4+
# gem "jekyll", "~> 3.5"
5+
gem "minimal-mistakes-jekyll"
6+
7+
# Packages used by githug-pages
8+
gem "github-pages", group: :jekyll_plugins
9+
# gem "tzinfo-data"
10+
# gem "wdm", "~> 0.1.0" if Gem.win_platform?
11+
12+

‎README.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
This is a simple website generated using the repository [mmistakes/minimal-mistakes](https://github.com/mmistakes/minimal-mistakes),
2+
online at [https://mmistakes.github.io/minimal-mistakes/](https://mmistakes.github.io/minimal-mistakes/).
3+
4+
[Jekyll](https://jekyllrb.com/) framework integrated with github-pages is the core of this automatic scripts.
5+
6+
## Useful info
7+
8+
* Folder `/_pages`: .md files can be added and will appear in the Sitemap.
9+
* `home.md` is the main page opened by your portal.
10+
* `page-archive.html`, `sitemap.md`, `tag-archive.md`, `year-archive.md`, `archive-layout-with-content.md` and `404.md` will rarely needed to be modified. These are files that automatic filter some of your content.
11+
* Folder `/_posts`: .md files are required starting with the same date template that is exemplified there.
12+
* Navigation bar can be edit in `/_data/navigation.yml`
13+
* The folder suggested for inserting your images is `/assets/images`
14+
15+
16+
## [DEV-MODE] - Running locally on Ubuntu 18.04
17+
Packages install process is described at A1) and A2).
18+
19+
After these steps, command `./execBundleJekyllServe.sh` should be executed and localhost:4000 should direct to your portal.
20+
21+
### A1) Installing the correct ruby version
22+
23+
First step is to install the correct packages. Follow: [GoRails setup](https://gorails.com/setup/ubuntu/18.04)
24+
25+
```
26+
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
27+
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
28+
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
29+
30+
sudo apt-get update
31+
sudo apt-get install git-core curl zlib1g-dev build-essential libssl-dev libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev software-properties-common libffi-dev nodejs yarn`
32+
```
33+
34+
```
35+
cd
36+
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
37+
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
38+
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
39+
exec $SHELL
40+
41+
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
42+
echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc
43+
exec $SHELL
44+
45+
rbenv install 2.5.1
46+
rbenv global 2.5.1
47+
ruby -v
48+
```
49+
50+
### A2) Next steps are described at [Jekyll](https://jekyllrb.com/)
51+
52+
```
53+
gem install bundler jekyll
54+
55+
jekyll new my-awesome-site
56+
57+
cd my-awesome-site
58+
59+
bundle exec jekyll serve
60+
61+
# => Now browse to http://localhost:4000
62+
```

‎_config.yml

+298
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,298 @@
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your entire site, values
4+
# which you are expected to set up once and rarely need to edit after that.
5+
# For technical reasons, this file is *NOT* reloaded automatically when you use
6+
# `jekyll serve`. If you change this file, please restart the server process.
7+
8+
remote_theme : "mmistakes/minimal-mistakes"
9+
#Local theme used for local tests
10+
#theme : "minimal-mistakes-jekyll"
11+
12+
minimal_mistakes_skin : "aqua" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
13+
14+
# Site Settings
15+
locale : "en-US"
16+
title : "OptFrame"
17+
title_separator : "--"
18+
name : &name "OptFrame" # &name is a YAML anchor which can be *referenced later
19+
description : &description "OptFrame portal"
20+
url : https://optframe.github.io # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
21+
baseurl : # "/minimal-mistakes" # the subpath of your site, e.g. "/blog"
22+
repository : "optframe/optframe.github.io"
23+
teaser : # path of fallback teaser image, e.g. "/assets/images/500x300.png"
24+
# breadcrumbs : false # true, false (default)
25+
words_per_minute : 200
26+
comments:
27+
provider : "staticman_v2" # false (default), "disqus", "discourse", "facebook", "google-plus", "staticman_v2", "staticman" "custom"
28+
disqus:
29+
shortname :
30+
discourse:
31+
server : # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org
32+
facebook:
33+
# https://developers.facebook.com/docs/plugins/comments
34+
appid :
35+
num_posts : # 5 (default)
36+
colorscheme : # "light" (default), "dark"
37+
staticman:
38+
allowedFields : # ['name', 'email', 'url', 'message']
39+
branch : "master"
40+
commitMessage : # "New comment"
41+
filename : # comment-{@timestamp}
42+
format : # "yml"
43+
moderation : # true
44+
path : # "_data/comments/{options.slug}"
45+
requiredFields : # ['name', 'email', 'message']
46+
transforms:
47+
email : # "md5"
48+
generatedFields:
49+
date:
50+
type : # "date"
51+
options:
52+
format : # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds"
53+
reCaptcha:
54+
siteKey : "6LdRBykTAAAAAFB46MnIu6ixuxwu9W1ihFF8G60Q"
55+
secret : "PznnZGu3P6eTHRPLORniSq+J61YEf+A9zmColXDM5icqF49gbunH51B8+h+i2IvewpuxtA9TFoK68TuhUp/X3YKmmqhXasegHYabY50fqF9nJh9npWNhvITdkQHeaOqnFXUIwxfiEeUt49Yoa2waRR7a5LdRAP3SVM8hz0KIBT4="
56+
57+
atom_feed:
58+
path : # blank (default) uses feed.xml
59+
60+
search : true # true, false (default)
61+
search_full_content : true # true, false (default)
62+
search_provider : algolia # lunr (default), algolia
63+
algolia:
64+
application_id : # QB6HVGBSBA # YOUR_APPLICATION_ID
65+
index_name : # vncoelho # YOUR_INDEX_NAME
66+
search_only_api_key : # 9d5014e5bbc77372547bce778dfa5663 # YOUR_SEARCH_ONLY_API_KEY
67+
powered_by : # true # true (default), false
68+
files_to_exclude:
69+
- _posts/2017-11-28-post-exclude-search.md
70+
71+
# SEO Related
72+
google_site_verification : # "UQj93ERU9zgECodaaXgVpkjrFn9UrDMEzVamacSoQ8Y" # Replace this with your ID, or delete
73+
bing_site_verification :
74+
yandex_site_verification :
75+
naver_site_verification :
76+
77+
# Social Sharing
78+
twitter:
79+
username : &twitter ""
80+
facebook:
81+
username : &facebook ""
82+
app_id :
83+
publisher :
84+
og_image : "/assets/images/favicon.png" # Open Graph/Twitter default site image
85+
# For specifying social profiles, used in _includes/seo.html
86+
# - https://developers.google.com/structured-data/customize/social-profiles
87+
social:
88+
type : # Person or Organization (defaults to Person)
89+
name : # If the user or organization name differs from the site's name
90+
links: # An array of links to social media profiles
91+
- "https://twitter.com/mmistakes"
92+
- "https://facebook.com/michaelrose"
93+
94+
# Analytics
95+
analytics:
96+
provider : "google-universal" # false (default), "google", "google-universal", "custom"
97+
google:
98+
tracking_id : # Replace this with your ID, or delete
99+
anonymize_ip : true
100+
101+
102+
# Site Author
103+
author:
104+
name : *name # *name is a YAML reference pointing to the &anchor earlier
105+
avatar : "/assets/images/favicon.png"
106+
bio : "OptFrame - Optimization Framework "
107+
location : "On a sea of local optima"
108+
email :
109+
uri : *url
110+
home : *url
111+
bitbucket :
112+
codepen :
113+
dribbble :
114+
flickr :
115+
facebook : *facebook
116+
foursquare :
117+
github : "OptFrame"
118+
gitlab :
119+
google_plus :
120+
keybase :
121+
instagram :
122+
lastfm :
123+
linkedin :
124+
pinterest :
125+
soundcloud :
126+
stackoverflow : # https://stackoverflow.com/users/123456/username
127+
steam :
128+
tumblr :
129+
twitter : *twitter
130+
vine :
131+
weibo :
132+
xing :
133+
youtube :
134+
135+
#Extra config added for running locally with remote_theme
136+
github: [metadata]
137+
138+
# Reading Files
139+
include:
140+
- .htaccess
141+
- _pages
142+
exclude:
143+
- "*.sublime-project"
144+
- "*.sublime-workspace"
145+
- vendor
146+
- .asset-cache
147+
- .bundle
148+
- .jekyll-assets-cache
149+
- .sass-cache
150+
- assets/js/plugins
151+
- assets/js/_main.js
152+
- assets/js/vendor
153+
- Capfile
154+
- CHANGELOG
155+
- config
156+
- Gemfile
157+
- Gruntfile.js
158+
- gulpfile.js
159+
- LICENSE
160+
- log
161+
- node_modules
162+
- package.json
163+
- Rakefile
164+
- README
165+
- tmp
166+
keep_files:
167+
- .git
168+
- .svn
169+
encoding: "utf-8"
170+
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
171+
172+
173+
# Conversion
174+
markdown: kramdown
175+
highlighter: rouge
176+
lsi: false
177+
excerpt_separator: "\n\n"
178+
incremental: false
179+
180+
181+
# Markdown Processing
182+
kramdown:
183+
input: GFM
184+
hard_wrap: false
185+
auto_ids: true
186+
footnote_nr: 1
187+
entity_output: as_char
188+
toc_levels: 1..6
189+
smart_quotes: lsquo,rsquo,ldquo,rdquo
190+
enable_coderay: false
191+
192+
193+
# Collections
194+
collections:
195+
docs:
196+
output: true
197+
permalink: /:collection/:path/
198+
199+
200+
# Defaults
201+
defaults:
202+
# _posts
203+
- scope:
204+
path: ""
205+
type: posts
206+
values:
207+
layout: single
208+
author_profile: true
209+
read_time: true
210+
comments: true
211+
share: true
212+
related: true
213+
# _pages
214+
- scope:
215+
path: "_pages"
216+
type: pages
217+
values:
218+
layout: single
219+
author_profile: true
220+
# _docs
221+
- scope:
222+
path: ""
223+
type: docs
224+
values:
225+
layout: single
226+
read_time: false
227+
author_profile: false
228+
share: false
229+
comments: false
230+
sidebar:
231+
nav: "docs"
232+
233+
234+
# Sass/SCSS
235+
sass:
236+
sass_dir: _sass
237+
style: compressed # http://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
238+
239+
240+
# Outputting
241+
permalink: /:categories/:title/
242+
# paginate: 5 # amount of posts to show
243+
# paginate_path: /page:num/
244+
timezone: America/New_York # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
245+
246+
247+
# Plugins (previously gems:)
248+
plugins:
249+
- jekyll-paginate
250+
- jekyll-sitemap
251+
- jekyll-gist
252+
- jekyll-feed
253+
- jemoji
254+
255+
# mimic GitHub Pages with --safe
256+
whitelist:
257+
- jekyll-paginate
258+
- jekyll-sitemap
259+
- jekyll-gist
260+
- jekyll-feed
261+
- jemoji
262+
263+
264+
# Archives
265+
# Type
266+
# - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default)
267+
# - Jekyll Archives plugin archive pages ~> type: jekyll-archives
268+
# Path (examples)
269+
# - Archive page should exist at path when using Liquid method or you can
270+
# expect broken links (especially with breadcrumbs enabled)
271+
# - <base_path>/tags/my-awesome-tag/index.html ~> path: /tags/
272+
# - <base_path/categories/my-awesome-category/index.html ~> path: /categories/
273+
# - <base_path/my-awesome-category/index.html ~> path: /
274+
category_archive:
275+
type: liquid
276+
path: /categories/
277+
tag_archive:
278+
type: liquid
279+
path: /tags/
280+
# https://github.com/jekyll/jekyll-archives
281+
# jekyll-archives:
282+
# enabled:
283+
# - categories
284+
# - tags
285+
# layouts:
286+
# category: archive-taxonomy
287+
# tag: archive-taxonomy
288+
# permalinks:
289+
# category: /categories/:name/
290+
# tag: /tags/:name/
291+
292+
293+
# HTML Compression
294+
# - http://jch.penibelst.de/
295+
compress_html:
296+
clippings: all
297+
ignore:
298+
envs: development

0 commit comments

Comments
 (0)