Textalic is a simple, responsive jekyll theme focus on blogging. Here is a live demo.
- Post category, tag and series
- Github flavored markdown rendering
- LaTeX and ascii math notation rendering
- Disqus comment and Gitalk comment
- Fulltext search (powered by jekyll-simple-search plugin)
- Code highlighting
- Autogenerate table of content
- Google analytics
- Atom feed
- Sitemap
Make sure you have set up jekyll correctly. See the official jekyll doc.
Clone this repo into to your local machine, then cd
to the root directory of
your local copy. Here is an overview of the project's file structure:
jekyll-theme-textalic
├── 404.html # 404 page
├── Gemfile
├── LICENCE
├── _config.yml # Main config
├── _data
│ └── me.yml # Personal info config
├── _demo_series # A demo series, add series into series folder
│ └── demo_series_post_1.md
├── _includes
├── _layouts
├── _posts
│ └── 2019-12-25-Intro.md # Add new post here
├── _sass
├── about # About page
├── assets # images, fonts, css, js...
│ ├── img
│ │ ├── me.png # Replace with your own, showed in /about page
├── favicon.ico # Replace with your own
├── feed.xml
├── index.html
├── resume
│ └── index.md # You may write your resume here. linked in /about page
├── search.json
├── series
└── tag
Run the following command to install required gems defined in Gemfile
:
$ bundle install
Edit _config.yml
and _data/me.yml
to tweek the site configuration to your
need. See corresponding comments in these files for details.
You also should replace the /favicon.ico
and /assets/img/me.png
file with
your own.
Run bundle exec jekyll serve --watch
to run it locally.
You can begin writting your posts under /_posts
folder.
See Jekyll doc on posts.
Posts are automatically grouped under site's post/category and post/tag menu.
You can define post's category and tags in the post's front matter,
using category
and tags
front matter block.
You can enable latex math support or asciimath support by adding usemath: latex
or usemath: ascii
front matter accordingly. Latex math notation must be wrapped
inside $$, and asciimath notation must be wrapped inside \`.
For detail configuration and math rendering result, see https://unifreak.github.io/jekyll-theme-textalic/demo/Blogging
Series are implemented using Jekyll's collections. To add new series, follow these steps:
-
Define a new collection in
_config.yml
, undercollections
configuration block:collections: demo_series: output: true
Note that to make the change to
_config.yml
take effects, you need to restart jekyll. -
Create the series (aka collection) folder
/_demo_series
. Note that the folder name begin with_
. -
By adding new post under the series folder, you add post under the corresponding series.
Happy blogging!