Based on Jekyll theme: Lanyon by Mark Otto
- add-ons by Samir Amin
- Site features | Example contents
- License: Open sourced under the MIT license.
- Edit lines where text string
foo
is present with relevant information. - Add relevant author and owner information
- For proper sidebar, meta info below post title, and footer bar, add at least twitter, google plus info under
owner
andsidebar
section. - Uncomment and add relevant user names/keys to enable features, e.g., google analytics, disqus comments, twitter widget, google custom search.
- For proper sidebar, meta info below post title, and footer bar, add at least twitter, google plus info under
- Read Using a custom domain with GitHub Pages for set-up details.
- If you are hosting website on domain other than
github.io
, renameCNAME.sample
file toCNAME
, and add your custom domain name, e.g.,example.com
(only one domain is allowed), otherwise removeCNAME
file if you want to host at defaultgithub.io
. - If you are hosting website on
github.io
, replaceexample.com
withhttps://<github-username>.github.io/<repository_name>
(for project site) orhttps://<github-username>.github.io
(for user site) undersite.url
andsite.urlimg
in_config.yml
and_prose.yml
file.
- See more at https://travis-ci.org/getting_started
- https://github.com/prose/prose/wiki/Getting-Started
- Edit
example.com
with your domain name. - You may edit names for custom categories.
- replace
example.com
with your valid url. - Edit search engine inclusion/exclusion if desired.
-
_data/socialmedia.html
- Replace user
foo
with appropriate username
- Replace user
-
_includes/
- Check if file paths for appropriate urls have valid css files, scripts, icons, and images in
head.html
andhead_minimal.html
, else comment html tags which are not being used. - Also, check if variables (twitter, google plus, linkedin, google analytics key and disqus username, etc.) are specified in
_config.yml
located under root path. - You may edit
meta_info.html
,footer.html
and similar include files to add/remove elements in page meta bar, footer, etc. - For publications page,
mypubs.html
andmyaoi.html
are trimmed outputs from zot_bib_web. Github pages can not dynamically build these pages. Alternately, you may exportbib
format for publications under/files/
directory which can be parsed dynamically using bibbase.org _includes/footer.html
: Edit copyright information as needed.
- Check if file paths for appropriate urls have valid css files, scripts, icons, and images in
-
_layouts
- To add/remove/reorder page/post contents, edit
default.html
pluspage.html
orpost.html
.
- To add/remove/reorder page/post contents, edit
-
_posts
- Live blog posts goes here with markdown formatted post. File name format must have following date-title format
yyyy-mm-dd-title.md
for jekyll to render blog post correctly. - YAML sample header shows all available options. Minimal required elements are: layout, title and date. Date tag overrides date given in post file name.
- Live blog posts goes here with markdown formatted post. File name format must have following date-title format
-
blog/index.html
- Edit blog title and description.
-
images/
- Under
icons
directory, keep appropriate sized favicons and thumbnails as specified in_includes/head.html
and_includes/head_minimal.html
- Also, keep
favicon.png
andfavicon.ico
in root directory. - Final,
images/icons/
should have following images with exact filenames and image size as specified in respective filenames. These images can be generated using online favicon generator. Replacefoo
with your site title or other name if desired.
- Under
example.com/images/icons/apple-touch-icon-precomposed.png
example.com/images/icons/apple-touch-icon-72x72-precomposed.png
example.com/images/icons/apple-touch-icon-114x114-precomposed.png
example.com/images/icons/apple-touch-icon-144x144-precomposed.png
example.com/images/icons/apple-touch-icon-180x180.png
example.com/images/icons/android-icon-192x192.png
syspages/
:- Edit page title and description in YAML front matter.
- For web search to work, specify Google Custom Search Engine API key for
google_search
variable. - Tag generation is experimental and dynamic size for tag box may need to be adjusted if you have more than 100 posts with one or two frequently occurring tags.
- All
{% for ... %}...{% endfor %}
loop operations will increase site build time, and remove such features (tags, meta info, related posts, etc.) under_includes
,_layouts
andsyspages
if required.
pages/contact.md
- Edit page title and description.
- Edit address, driving direction url, etc.
pages/cv.md
- Edit
_config.yml
to add twitter, google plus, linkedin, google scholar, ORCID profile info under owner heading. - Add pdf at
{{ site.url }}/cv/cv.pdf
- Edit
pages/publications.md
- Add your publications at
/files/mypubs.bib
and_includes/mypubs.html
. See above under_includes
for more.
- Add your publications at
pages/disclosure.md
- Appreciated if you keep relevant credits in disclosure page.
humans.txt
- Replace
foo
with your name.
- Replace
rfeed.xml
- Not required unless you are cross-posting about R language on blog aggregation site(s).
END