Skip to content

About

A hacker-like, highly-customizable theme for note-keeping, personal-website or CV.

Resources

Stars

141 stars

Watchers

5 watching

Forks

Latest commit

 

History

54 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Forks Stars Issues MIT License

pRoJEct-VeXEd

A customizable Jekyll theme for notes, blogs, portfolios, and CV-style personal sites.

Demo: View Demo

Features

  • A hacker-inspired, highly customizable Jekyll theme for notes, portfolios, and personal sites.
  • Organize articles with Jekyll collections, so different types of content can be managed without extra recoding.
  • Include encrypted text support for protected content display.
  • Provide bilingual switching for multilingual writing and reading.

homepage opening

Quick Start

Requirements

  • Ruby
  • Bundler

Install Bundler if needed:

gem install bundler

Install project dependencies:

bundle install

Run locally

bundle exec jekyll serve

Then open http://127.0.0.1:4000.

Installation

Clone your fork:

git clone https://github.com/<YOUR_USERNAME>/<YOUR_REPOSITORY>.git
cd <YOUR_REPOSITORY>

Customization

Site config

Edit _config.yml to update your site information and settings.

Collections

Store your content under ./collections/ and register each collection in _config.yml.

Example:

collections:
  notes:
    output: true
    permalink: /:collection/:title/
    sort_by: date

  portfolio:
    output: true
    permalink: /:collection/:title/
    order:
      - portfolio3.md
      - portfolio2.md
      - portfolio1.md

  album:
    output: true
    permalink: /:collection/:title/
    sort_by: date

All collection entries are available from the Archive page.

Writing

Remove the sample collections under ./collections/, then start adding your own content.

Comments

Create a Disqus account and set disqus_username in _config.yml.

Front Matter

Jekyll pages can be customized with Front Matter.

Reference: https://jekyllrb.com/docs/front-matter/

Contributing

Contributions are welcome.

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push the branch
  5. Open a pull request

License

Distributed under the MIT License. See LICENSE for details.

About

A hacker-like, highly-customizable theme for note-keeping, personal-website or CV.

Resources

Stars

141 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages