diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..afe0298 --- /dev/null +++ b/.gitignore @@ -0,0 +1,137 @@ +*~ + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + + +# github pages +Gemfile.lock +_site +.bundle \ No newline at end of file diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..e66779b --- /dev/null +++ b/Gemfile @@ -0,0 +1,29 @@ +source "https://rubygems.org" + +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +# gem "jekyll", "~> 3.8.3" + +# This is the default theme for new Jekyll sites. You may change this to anything you like. +# gem "minima", "~> 2.0" + +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +gem "github-pages", group: :jekyll_plugins + +# If you have any plugins, put them here! +# group :jekyll_plugins do +# gem "jekyll-feed", "~> 0.6" +# end + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +# gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] + +# Performance-booster for watching directories on Windows +# gem "wdm", "~> 0.1.0" if Gem.win_platform? diff --git a/_config.yml b/_config.yml index c419263..9018f2d 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1,39 @@ -theme: jekyll-theme-cayman \ No newline at end of file +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely edit after that. If you find +# yourself editing this file very often, consider using Jekyll's data files +# feature for the data you need to update frequently. +# +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. + +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. +title: BeeRef +description: A Simple Reference Image Viewer +baseurl: "/beeref" # the subpath of your site, e.g. /blog +# url: "" # the base hostname & protocol for your site, e.g. http://example.com + +# Build settings +markdown: kramdown +theme: jekyll-theme-cayman +# plugins: +# - jekyll-feed + +# Exclude from processing. +# The following items will not be processed, by default. Create a custom list +# to override the default setting. +exclude: + - Gemfile + - Gemfile.lock + - beeref + - htmlcov + - dist + - build + - tests + - "*.egg-info" + - "*.spec" \ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 0000000..9aacddd --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,31 @@ + + + + +{% seo %} + + + + + + + + + + +
+ {{ content }} + + +
+ + diff --git a/assets/css/style.scss b/assets/css/style.scss new file mode 100644 index 0000000..7161f3a --- /dev/null +++ b/assets/css/style.scss @@ -0,0 +1,39 @@ +--- +--- + +@import "{{ site.theme }}"; + +.page-header { + background-color: rgba(160,42,111,1); + background-image: linear-gradient( + 90deg, + rgba(0,184,200,1) 0%, + rgba(49,58,180,1) 50%, + rgba(160,42,111,1) 100%, + ); +} + +.main-content h1, +.main-content h2, +.main-content h3, +.main-content h4, +.main-content h5, +.main-content h6 { + color: rgba(160,42,111,1); +} + +a { + color: rgba(49,58,180,1); +} + +.page-header .logo { + @include large { + width: 5rem; + } + @include medium { + width: 3.5rem; + } + @include small { + width: 2.7rem; + } +} diff --git a/assets/images/feed_icon.png b/assets/images/feed_icon.png new file mode 100644 index 0000000..a9bf039 Binary files /dev/null and b/assets/images/feed_icon.png differ diff --git a/assets/images/feed_icon.svg b/assets/images/feed_icon.svg new file mode 100644 index 0000000..eb021a5 --- /dev/null +++ b/assets/images/feed_icon.svg @@ -0,0 +1,110 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/images/logo.png b/assets/images/logo.png new file mode 100644 index 0000000..b9965fc Binary files /dev/null and b/assets/images/logo.png differ diff --git a/assets/images/screenshot.png b/assets/images/screenshot.png new file mode 100644 index 0000000..bac2193 Binary files /dev/null and b/assets/images/screenshot.png differ diff --git a/assets/images/screenshot_float.png b/assets/images/screenshot_float.png new file mode 100644 index 0000000..8060be5 Binary files /dev/null and b/assets/images/screenshot_float.png differ diff --git a/index.md b/index.md index 627856c..61f779b 100644 --- a/index.md +++ b/index.md @@ -1,37 +1,40 @@ -## Welcome to GitHub Pages +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults -You can use the [editor on GitHub](https://github.com/rbreu/beeref/edit/gh-pages/index.md) to maintain and preview the content for your website in Markdown files. +layout: default +--- -Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. +BeeRef lets you quickly arrange your reference images and view them while you create. Its minimal interface is designed not to get in the way of your creative process. -### Markdown +![Screenshot of BeeRef]({{ site.baseurl}}/assets/images/screenshot.png) -Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for -```markdown -Syntax highlighted code block +## Installation -# Header 1 -## Header 2 -### Header 3 +Get the zip file for your operating system (Windows, Linux, macOS) from the [latest release]({{ site.github.latest_release.html_url }}). Extract the zip file. Inside the extracted folder, you will find a BeeRef executable. -- Bulleted -- List +**Linux users** who want to have BeeRef appear in the app menu, save the desktop file from the [release section]({{ site.github.latest_release.html_url }}) in `~/.local/share/applications` and adjust the path names in the file to match the location of your BeeRef installation. -1. Numbered -2. List -**Bold** and _Italic_ and `Code` text +## Features -[Link](url) and ![Image](src) +* Move, scale, rotate and flip images +* Mass-scale images to the same width, height or size +* Mass-arrange images vertically, horizontally or for optimal usage of space +* Enable alaways-on-top-mode and disable the title bar to let the BeeRef window unobtrusively float above your art program: + +![Screenshot of BeeRef over other program]({{ site.baseurl}}/assets/images/screenshot_float.png) + + +### Regarding the bee file format + +Currently, all images are embedded into the bee file as png files. While png is a lossless format, it may also produce larger file sizes than compressed jpg files, so bee files may become bigger than the imported images on their own. More embedding options are to come later. + +The bee file format is a sqlite database inside which the images are stored in an sqlar table—meaning they can be extracted with the [sqlite command line program](): + +``` +sqlite3 myfile.bee -Axv ``` -For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). - -### Jekyll Themes - -Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/rbreu/beeref/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. - -### Support or Contact - -Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. +Options for exporting from inside BeeRef are planned, but the above always works independently of BeeRef. \ No newline at end of file