Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
badarsebard committed Jul 4, 2024
1 parent 1d92d21 commit 2cf9f78
Show file tree
Hide file tree
Showing 20 changed files with 572 additions and 4 deletions.
15 changes: 15 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
node_modules/
dist/
.vscode/
.DS_Store
.idea
.run
.vite/

local/
build/
bin/
wailsjs/

Gemfile.lock
_site
23 changes: 23 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
source "https://rubygems.org"

gem "bulma-clean-theme"
group :jekyll_plugins do
gem "github-pages", "~> 231"
gem 'jemoji'
end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1", "< 3"
gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

gem "webrick", "~> 1.8"
59 changes: 59 additions & 0 deletions docs/_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# 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: Taskmail
description: >-
Kanban-style email client
github_username: badarsebard
gh_sponsor: badarsebard
domain: taskmail.-is-local.org
url: "https://taskmail.is-local.org"

defaults:
- scope:
path: ""
type: "pages"
values:
hide_hero: true

images: "/assets/images"
favicon: "/assets/images/favicon-16x16.png"

feed:
disable_in_development: true
google_analytics: false

# Build settings
theme: bulma-clean-theme
fixed_navbar: top

plugins:
- jemoji
# - jekyll-feed

include:
- .well-known

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.

exclude:
- .sass-cache/
- .jekyll-cache/
- gemfiles/
- Gemfile
- Gemfile.lock
- node_modules/
- vendor/bundle/
- vendor/cache/
- vendor/gems/
- vendor/ruby/
9 changes: 9 additions & 0 deletions docs/_data/navigation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
- name: Roadmap
link: /roadmap
external: false
- name: Data Schema
link: /schema
external: false
- name: GitHub
link: https://github.com/badarsebard/Taskmail
external: true
15 changes: 15 additions & 0 deletions docs/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<footer class="footer">
<div class="container">
{% if site.footer_menu %}
<div class="columns is-multiline">
{% for item in site.data[site.footer_menu] %}
<div class="column has-text-centered">
<div>
<a href="{{ item.link | relative_url }}" class="link">{{ item.name }}</a>
</div>
</div>
{% endfor %}
</div>
{% endif %}
</div>
</footer>
2 changes: 2 additions & 0 deletions docs/_includes/head-scripts.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<link rel="icon" type="image/png" sizes="32x32" href="{{ site.images }}/favicon-32x32.png">
<script src="https://kit.fontawesome.com/001bd13219.js" crossorigin="anonymous"></script>
73 changes: 73 additions & 0 deletions docs/_includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<nav
class="navbar is-primary {% if site.fixed_navbar %} is-fixed-{{ site.fixed_navbar }} {% endif %}"
x-data="{ openNav: false }"
>
<div class="container">
<div class="navbar-brand">
<a href="{{ site.baseurl }}/" class="navbar-item">
{{ site.title }}
</a>
<a
role="button"
class="navbar-burger burger"
aria-label="menu"
aria-expanded="false"
data-target="navMenu"
:class="{ 'is-active': openNav }"
x-on:click="openNav = !openNav"
>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
</div>
<div class="navbar-menu" id="navMenu" :class="{ 'is-active': openNav }">
<div class="navbar-start">
<a href="{{ site.baseurl }}/" class="navbar-item {% if page.url == "/" %}is-active{% endif %}">Home</a>
{% if site.data.navigation %}
{% for item in site.data.navigation %}
{% if item.dropdown %}
<div class="navbar-item has-dropdown is-hoverable {% if site.fixed_navbar == 'bottom' %} has-dropdown-up {% endif %}">
<a
href="{{ item.link | relative_url }}"
class="navbar-link {% if page.url contains item.link %}is-active{% endif %}"
>
{{- item.name -}}
</a>
<div class="navbar-dropdown">
{% for subitem in item.dropdown %}
<a
href="{{ subitem.link | relative_url }}"
class="navbar-item {% if subitem.link == page.url %}is-active{% endif %}"
>
{{- subitem.name -}}
</a>
{% endfor %}
</div>
</div>
{% else %}
<a
href="{{ item.link | relative_url }}"
class="navbar-item {% if item.link == page.url %}is-active{% endif %}"
>
{{- item.name -}}
{% if item.external %}
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs" style="align-self: start; margin-top: .5rem; margin-left: .25rem;"></i>
{% endif %}
</a>
{% endif %}
{% endfor %}
{% endif %}
</div>

<div class="navbar-end">
{% if site.gh_sponsor %}
<a class="navbar-item" href="https://github.com/sponsors/{{ site.gh_sponsor }}">
<span class="icon gh-sponsor"><i class="fas fa-heart"></i></span>
<span>Sponsor</span>
</a>
{% endif %}
</div>
</div>
</div>
</nav>
10 changes: 10 additions & 0 deletions docs/assets/css/app.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
---

.content{
padding: 0 10rem;
}

$primary: #1F2937FF;
// Import Main CSS file from theme
@import "main";
Binary file added docs/assets/images/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/favicon.ico
Binary file not shown.
Binary file added docs/assets/images/github-mark-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added docs/assets/images/taskmail_demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!-- todo: provide instructions on how to set up local development environment -->
# Development
2 changes: 2 additions & 0 deletions docs/graph_app_registration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!-- todo: provide instructions for creating single tenant oauth app and using it in the config.yaml -->
# Graph App Registration
6 changes: 5 additions & 1 deletion docs/README.md → docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<img src="media/logo.png" width="200"/>
---
title: Taskmail
---

<img src="assets/images/taskmail_demo.png" alt="Taskmail demo screenshot" style="border: 2px solid grey;">

Taskmail is an app that combines an email client with a Kanban-style task board. Emails and tasks are presented in the same way and can be managed together or even combined.

## Active Development
Expand Down
Loading

0 comments on commit 2cf9f78

Please sign in to comment.