Minimal typewriter like portfolio theme for jekyll.
- Clear and minimalistic basic design
- Basic styled markdown support
- Responsive UI
- Configurable colors which can be changed as
sass
variables.
- Post categories handling
- Generic design for collections
- Navigation elements for post articles
- Add
gem "jekyll-remote-theme"
to yourGemfile
to add the theme as a dependancy - Run the command
bundle install
in the root of project to install the jekyll remote theme gem as a dependancy - Add
jekyll-remote-theme
to the list ofplugins
in your_config.yml
file - Add
remote_theme: daviddarnes/alembic@main
to your_config.yml
file to set the site theme - Run
bundle exec jekyll serve
to build and serve your site - Done! Use the configuration documentation and the example
_config.yml
file to set things like the navigation, contact form and social sharing buttons
To the default page
, post
and default
black-ink implements a new layout called home
which is the layout containing the description and the profile image. It even adds a basic post
list which links to all written posts.
File | Description |
---|---|
404.html |
404 page which can be included in \404.html |
footer.html |
Footer with copy right note and navigation bar |
head.html |
Link to stylesheet, MathJax and fontawesome |
header.html |
Title which links back to the homepage and a simple navigation bar |
nav.html |
Navigation bar used in the header and the footer |
posts_list.html |
List of posts which can be seen in the home screen |
social.html |
List of all social media links |
File | Description |
---|---|
black-ink.scss |
Configurable style variables and color scheme |
_normalize.scss |
Normalizes browser stylesheets from necolas |
highlight.scss |
Code highlighting |
_base.scss |
Main stylesheet |
_layout.scss |
Stylesheet for specific layouts |
custom-styles.scss |
Stylesheet to allow overwriting the basic stylesheet |
custom-variables.scss |
Stylesheet to overwrite existing variables used by the theme |
All configurable options are described in the _config.yml
file.
Bug reports and pull requests are welcome on GitHub at https://github.com/ucinereo/jekyll-black-ink. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The theme is available as open source under the terms of the MIT License.