Creating your first post in Jekyll
Create Post File To create a new post, you can create a new markdown file inside the _posts directory by following the recommended file naming format: YEAR-MONTH-DAY-title.MARKUP Where YEAR is a four-digit number, MONTH and DAY are both two-digit numbers, and MARKUP is the file extension representing the format used in the file. For example, the following are examples of valid post filenames: 2011-12-31-new-years-eve-is-awesome.md 2012-09-12-how-to-write-a-blog.md Post Front Matter Post requires front matter, everything in between the first and second —
Creating docs posts
Create new doc post entries in _docs folder, similar to creating posts, but with following front matter settings: --- title: Accordion container: wide-container category: element right_sidebar: true search: true banner: true tags: [content,element] custom_js: - assets/prism/prism.js #extra css files here custom_css: - assets/prism/prism.css #extra css files here --- Sidebar navigation on docs post can edited in _data/navigation_docs.yml: - title: Content img: img/side-nav/document.png docs: - doc-content-image # Doc file name from _docs folder - doc-content-video - doc-content-tooltip
Basic Theme Setup
This document covers the setup and options of theme feature described in the doc title Site details Add your site details in _config.yml : title: Docs description: Documentation Jekyll theme. lang: en # Site subpath, e.g. /blog baseurl: "" # Permalink URLs structure, for permalink style options see: https://jekyllrb.com/docs/permalinks/ permalink: /:title/ # Site base hostname & protocol, e.g. http://example.com url: "https://docs.jekyll.plus" # Site logo # e.g. logo.png, upload logo image file to /uploads/ folder logo: Update favicon You can find
Theme Installation
Extract the zipped package downloaded from ThemeForest to your desktop, in the extracted package you will find the docy-jekyll.zip (docy_version.zip) file which is the Jekylltheme. Now Install the dependencies with Bundler: bundle install Run the following to generate your site: bundle exec jekyll serve