First version of web page

This commit is contained in:
Rebecca Breu 2021-07-12 18:03:31 +02:00
parent 43842fd72a
commit fdcd198e8d
11 changed files with 413 additions and 26 deletions

137
.gitignore vendored Normal file
View file

@ -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

29
Gemfile Normal file
View file

@ -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?

View file

@ -1 +1,39 @@
theme: jekyll-theme-cayman
# 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"

31
_layouts/default.html Normal file
View file

@ -0,0 +1,31 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">
<head>
{% seo %}
<link rel="preconnect" href="https://fonts.gstatic.com">
<link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap" as="style" type="text/css" crossorigin>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#157878">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
</head>
<body>
<header class="page-header" role="banner">
<h1 class="project-name"><img class="logo" align="top" src="{{ site.baseurl}}/assets/images/logo.png"> {{ page.title | default: site.title | default: site.github.repository_name }}</h1>
<h2 class="project-tagline">{{ page.description | default: site.description | default: site.github.project_tagline }}</h2>
<a href="{{ site.github.latest_release.html_url }}" class="btn">Download {{ site.github.latest_release.tag_name }}</a>
<a href="{{ site.github.repository_url }}/discussions" class="btn">Discussions</a>
<a href="{{ site.github.repository_url }}/releases.atom" class="btn"><img align="bottom" width="16rem" src="{{ site.baseurl}}/assets/images/feed_icon.png"></a>
</header>
<main id="content" class="main-content" role="main">
{{ content }}
<footer class="site-footer">
<span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.title }}</a> is published under {{ site.github.license.name }}.</span>
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
</footer>
</main>
</body>
</html>

39
assets/css/style.scss Normal file
View file

@ -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;
}
}

BIN
assets/images/feed_icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

110
assets/images/feed_icon.svg Normal file
View file

@ -0,0 +1,110 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.1"
width="87.5"
height="87.5"
id="RSSicon"
viewBox="0 0 175 175"
sodipodi:docname="feed_icon.svg"
inkscape:version="1.0.2 (e86c870, 2021-01-15)"
inkscape:export-filename="/home/rbreu/code/python/beeref/git/images/feed_icon.png"
inkscape:export-xdpi="561.73999"
inkscape:export-ydpi="561.73999">
<metadata
id="metadata34">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1280"
inkscape:window-height="656"
id="namedview32"
showgrid="false"
inkscape:pagecheckerboard="true"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
inkscape:zoom="3.8671875"
inkscape:cx="42"
inkscape:cy="45"
inkscape:window-x="0"
inkscape:window-y="27"
inkscape:window-maximized="1"
inkscape:current-layer="RSSicon"
inkscape:document-rotation="0" />
<defs
id="defs17">
<linearGradient
x1="0.085000001"
y1="0.085000001"
x2="0.91500002"
y2="0.91500002"
id="RSSg">
<stop
offset="0.0"
stop-color="#E3702D"
id="stop2" />
<stop
offset="0.1071"
stop-color="#EA7D31"
id="stop4" />
<stop
offset="0.3503"
stop-color="#F69537"
id="stop6" />
<stop
offset="0.5"
stop-color="#FB9E3A"
id="stop8" />
<stop
offset="0.7016"
stop-color="#EA7C31"
id="stop10" />
<stop
offset="0.8866"
stop-color="#DE642B"
id="stop12" />
<stop
offset="1.0"
stop-color="#D95B29"
id="stop14" />
</linearGradient>
</defs>
<circle
cx="24"
cy="151"
r="24"
fill="#ffffff"
id="circle25" />
<path
d="M 116,175 H 82 A 82,82 0 0 0 0,93 V 59 a 116,116 0 0 1 116,116 z"
fill="#ffffff"
id="path27" />
<path
d="M 140,175 A 140,140 0 0 0 0,35 V 0 a 175,175 0 0 1 175,175 z"
fill="#ffffff"
id="path29" />
</svg>

After

Width:  |  Height:  |  Size: 2.9 KiB

BIN
assets/images/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 415 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 298 KiB

View file

@ -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](<https://www.sqlite.org/cli.html>):
```
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 well help you sort it out.
Options for exporting from inside BeeRef are planned, but the above always works independently of BeeRef.