White Paper is a theme for Jekyll. It is made keeping content in focus and is best for writers/developers who also like to share code with their essays.
jekyll-compose gem is now installed with jekyll so now creating a new post is as easy as running this simple command
# ensure all the required bundles are installed
bundle install
bundle exec jekyll post "Tooling Considered Harmful"
Configuration file: /Users/vinitkumar/projects/vinitkumar.github.com/_config.yml
New post created at _posts/2019-03-06-tooling-considered-harmful.md
$ git status
Untracked files:
(use "git add <file>..." to include in what will be committed)
_posts/2019-03-06-tooling-considered-harmful.md
Fork the repo to your account by clicking the button on the top right as shown in the image:
Next, Go the the project settings and change the repository name to <username>.github.io where username is your username.
Change these entries in the _config.yml file:
Also, change this line in head.html link
<!-- From this -->
<link rel="stylesheet" href=" {{ '/dist/css/main.min.css' | relative_url }}" type="text/css" />
<!-- To this -->
<link rel="stylesheet" href=" {{ '/dist/css/main.min.css' | absolute_url }}" type="text/css" />This will make sure that the path of CSS is correct and the theme loads correctly.
master_repo: false
url: "<username>.github.io"
rtl: false # change to true if posts is in Arabic/other Right to left language.Also, change all other fields in the _config.yml file to your choice.
This theme requires you to install couple of tools first to setup jekyll locally.
git clone git@github.com:vinitkumar/white-paper.git
# If you have ruby installed.
gem install jekyll bundler
# If you have node installed.
yarn install
bundle install
yarn build
bundle exec jekyll serve
# on running the serve script, the site will be live on
http://127.0.0.1:4000
This theme uses Vite to bundle and minify the CSS, then rtlcss to generate the right-to-left stylesheet. In order to prepare the CSS build, run yarn build.
It will create dist/css/main.min.css and dist/css/main.min.rtl.css.
This theme also provides syntax highlighting in different theme. Inside css folder, there is a syntax folder.
.
├── emacs.css
├── github.css
├── monokai.css
├── native.css
├── syntax.css
└── vim.css
Now in css/main.scss
@use 'base';
@use 'syntax/emacs'; // change this to another theme if you prefer, like vim.css, and run yarn buildThis project exists thanks to all the people who contribute. [Contribute].
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
- see LICENSE file
- Version 5.0.0
- Homepage: http://vinitkumar.me
- e-mail: mail@vinitkumar.me
- Twitter: @vinitkme
