Skip to content

Commit

Permalink
Change jekyll theme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jakob Jünger committed Dec 17, 2024
1 parent e425628 commit f755237
Show file tree
Hide file tree
Showing 32 changed files with 778 additions and 206 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
<img align="right" width="48" height="48" src="/docs/assets/img/epigraf-icon.png" alt="Epigraf logo">
<img align="right" width="48" height="48" src="assets/img/epigraf-icon.png" alt="Epigraf logo">

# Epigraf

Epigraf is a research platform for collecting, annotating, linking and publishing textual and multimodal data.
Epigraf is a research platform for collecting, annotating, linking and publishing multimodal text data.
The data model supports research databases ranging from epistolary editions to social media corpora.
Epigraf is currently used primarily for editing epigraphic data - inscriptions in connection with the objects to which they are attached.
It includes a publication system for various document formats such as Word or TEI, structured JSON, XML and CSV data, and triples in TTL, JSON-LD and RDF/XML.

You want to try it out? Contact us for a test account on one of our machines.
See the [user documentation](https://epigraf.inschriften.net/help)
and the [developer documentation](https://digicademy.github.io/epigraf/) for further information.

![Epigraf use cases](/docs/assets/img/epigraf-use-cases.png)
Want to try it out? Contact us for a test account on one of our machines.

*Note about the development status:* Epigraf has a history.
You will find archeological layers and legacy code from former development epochs
when visiting the code base and documentation.
Some of them are well preserved, others are deteriorating.
In any case, they provide fertile soil for future development.
Look out for the flowers that are in bloom and help nurture the garden.

![Epigraf use cases](assets/img/epigraf-use-cases.png)

![Edit with Epigraf](/docs/assets/img/edit-with-epigraf_playground~394.png)

## How to run Epigraf

Expand Down Expand Up @@ -42,8 +49,10 @@ and the [developer documentation](https://digicademy.github.io/epigraf/) for fur

5. Login to Epigraf at http://localhost with username and password `admin`.

What's next? Get familiar with the [Epigraf configuration](https://epigraf.inschriften.net/help) to adapt it to your use case.

See the [docker](docker) folder for more options.
Have a look at the [docker](docker) folder for more options for running Epigraf.
See the [developer documentation](https://digicademy.github.io/epigraf/) for background information.

## Authors and Citation
Epigraf is developed by the
Expand All @@ -52,6 +61,7 @@ and the research group
[Digital Media & Computational Methods at the University of Münster](https://www.uni-muenster.de/Kowi/institut/arbeitsbereiche/digital-media-computational-methods.shtml), Germany.

**Citation**

Jünger, J., Hertkorn, G., Gärtner, C.,
Herold, J., Knispel, J., Kopp, M.,Kotthoff, H., Lentge, F., Michel, M., Syring, W-D. (2024).
Epigraf: a research platform for collecting, annotating, linking and publishing multimodal text data.
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.jekyll-cache
_site
5 changes: 4 additions & 1 deletion docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@ gem "minima", "~> 2.5"
# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
#gem "github-pages"
gem "jekyll-include-cache"
end

# use Minimal Mistakes theme
gem "jekyll-remote-theme"
gem "just-the-docs"
gem "minimal-mistakes-jekyll"

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
Expand Down
143 changes: 143 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
colorator (1.1.0)
concurrent-ruby (1.3.3)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
faraday (2.12.2)
faraday-net_http (>= 2.0, < 3.5)
json
logger
faraday-net_http (3.4.0)
net-http (>= 0.5.0)
ffi (1.17.0)
ffi (1.17.0-arm64-darwin)
ffi (1.17.0-x86_64-darwin)
ffi (1.17.0-x86_64-linux-gnu)
forwardable-extended (2.6.0)
google-protobuf (3.25.3)
google-protobuf (3.25.3-arm64-darwin)
google-protobuf (3.25.3-x86_64-darwin)
google-protobuf (3.25.3-x86_64-linux)
http_parser.rb (0.8.0)
i18n (1.14.5)
concurrent-ruby (~> 1.0)
jekyll (4.3.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (>= 0.3.6, < 0.5)
pathutil (~> 0.9)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
jekyll-gist (1.5.0)
octokit (~> 4.2)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-paginate (1.1.0)
jekyll-remote-theme (0.4.3)
addressable (~> 2.0)
jekyll (>= 3.5, < 5.0)
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
rubyzip (>= 1.3.0, < 3.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
json (2.9.0)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
logger (1.6.3)
mercenary (0.4.0)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minimal-mistakes-jekyll (4.26.2)
jekyll (>= 3.7, < 5.0)
jekyll-feed (~> 0.1)
jekyll-gist (~> 1.5)
jekyll-include-cache (~> 0.1)
jekyll-paginate (~> 1.1)
jekyll-sitemap (~> 1.3)
net-http (0.6.0)
uri
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (6.0.0)
rake (13.2.1)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.3.1)
strscan
rouge (4.3.0)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sass-embedded (1.69.5)
google-protobuf (~> 3.23)
rake (>= 13.0.0)
sass-embedded (1.69.5-arm64-darwin)
google-protobuf (~> 3.23)
sass-embedded (1.69.5-x86_64-darwin)
google-protobuf (~> 3.23)
sass-embedded (1.69.5-x86_64-linux-gnu)
google-protobuf (~> 3.23)
sawyer (0.9.2)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
strscan (3.1.0)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.5.0)
uri (1.0.2)
webrick (1.8.1)

PLATFORMS
arm64-darwin
ruby
x86_64-darwin
x86_64-linux

DEPENDENCIES
http_parser.rb (~> 0.6.0)
jekyll (~> 4.3.3)
jekyll-feed (~> 0.12)
jekyll-include-cache
jekyll-remote-theme
minima (~> 2.5)
minimal-mistakes-jekyll
tzinfo (>= 1, < 3)
tzinfo-data
wdm (~> 0.1.1)

BUNDLED WITH
2.5.14
Loading

0 comments on commit f755237

Please sign in to comment.