mikaela.github.io/README.markdown

2.7 KiB
Raw Blame History

aminda.eu

pre-commit.ci status

This website should be fairly typical Jekyll project. The index contains rel=me links everywhere so projects such as Mastodon give me the green checkmark.

Automaattinen sisällysluettelo / Automatically generated Table of Contents

Sitemaps

  • sitemap.xml — automatically generated by Jekyll when building
  • sitemaps.xml — manually written sitemap index pointing to sitemaps on my sites. I am not sure how it works when there are multiple domains, so I am keeping all sitemaps in robots.txt and sitemaps.xml on bottom of it. Same will possibly happen with other domains.

Unusual directories

Or directories that generally arent encountered in other similar projects.

  • n/ - quick notes for my personal reference with memorable addresses.
  • r/ - my personal url redirector for links that I have to refer to more or less often.
  • txt/ - signed text files such as account list to decrease impact of identity theft attempts.
  • PGP/ - my current and some previous PGP keys.

Submodules

  • ir/ - list of I2P services, previously a part of this repository for memorable addresses.
  • lfs-media/ - orphan branch containing lfs-media such as the avatars. However it doesnt work with GitHub pages.
  • or/ - same as ir/, but for Tor Onion Services.

Building

  1. Install rbenv and its ruby-build plugins. Refer to rbenv/rbenv README.md for more information
  2. cd to root of this repository, if you didnt already.
  3. Install the required Ruby version by rbenv install
  4. Optionally configure where you wish bundler to install everything by e.g. bundle config set --local path 'vendor/bundle', but the rbenv default should work just fine
  5. Run bundle install
  6. You are done, bundle exec jekyll <build|serve> and similar commands should work. I suggest bundle exec jekyll serve -lo which will livereload and open the web browser for you.