aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJieiku2022-05-31 02:52:29 -0700
committerJieiku2022-05-31 02:52:29 -0700
commit64a9b12ea4262ed8bb49367902af5ec803f13444 (patch)
treebd06823ee2ebdd2cbad01eb249af0743361c4464
parentf9373880f609eb3af95deefe653abb55288c3418 (diff)
downloadabridge-64a9b12ea4262ed8bb49367902af5ec803f13444.tar.gz
abridge-64a9b12ea4262ed8bb49367902af5ec803f13444.tar.bz2
abridge-64a9b12ea4262ed8bb49367902af5ec803f13444.zip
Update Readme, Workflow Action, Whitespace Cleanup
-rw-r--r--.github/workflows/actions.yml26
-rw-r--r--.gitignore2
-rw-r--r--README.md18
-rw-r--r--content/pages/about.md2
-rw-r--r--content/pages/privacy.md2
-rw-r--r--templates/base.html8
-rw-r--r--templates/macros/macros.html37
7 files changed, 63 insertions, 32 deletions
diff --git a/.github/workflows/actions.yml b/.github/workflows/actions.yml
new file mode 100644
index 0000000..24d267d
--- /dev/null
+++ b/.github/workflows/actions.yml
@@ -0,0 +1,26 @@
+name: Generate Sponsors README
+on:
+ push:
+ branches:
+ - master
+ pull_request:
+ branches:
+ - master
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout πŸ›ŽοΈ
+ uses: actions/checkout@v2
+
+ - name: Generate Sponsors πŸ’–
+ uses: JamesIves/github-sponsors-readme-action@v1.0.8
+ with:
+ token: ${{ secrets.PAT }}
+ file: 'README.md'
+
+ - name: Deploy to GitHub Pages πŸš€
+ uses: JamesIves/github-pages-deploy-action@v4
+ with:
+ branch: master
+ folder: '.' \ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 4636c6c..16f9615 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,2 @@
public
-themes
+themes \ No newline at end of file
diff --git a/README.md b/README.md
index cbc1e95..867bd7b 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,11 @@
# Abridge Zola Theme
-Abridge is a fast and lightweight Zola theme using semantic html, a class-light [abridge.css](https://github.com/jieiku/abridge.css), and No JS.
+Abridge is a fast and lightweight Zola theme using semantic html, a class-light [abridge.css](https://github.com/jieiku/abridge.css), and No JS[*](https://github.com/Jieiku/abridge#contributing-and-philosophy).
-![abridge](screenshot.png)
+Maintainence of this project is made possible by all the <a href="https://github.com/Jieiku/abridge/graphs/contributors">contributors</a> and <a href="https://github.com/sponsors/Jieiku">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href="https://github.com/sponsors/Jieiku">click here</a>. πŸ’–
+
+<!-- sponsors --><a href="https://github.com/yugfletcher"><img src="https://github.com/yugfletcher.png" width="60px" alt="" /></a><!-- sponsors -->
</div>
@@ -279,7 +281,7 @@ optipng -o7 -zm1-9 -strip all *.png
### Consolidate two search js files into one:
Optionally you can serve a single js file for the search instead of a separate index by combining the two:
-(although I am not sure how to accomplish this if your using the theme as a submodule)
+(although I am not sure how to accomplish this if your using the theme as a submodule, maybe you can use a git action for this command depending on your hosting provider.)
First comment out this line in config.toml:
@@ -327,11 +329,15 @@ Please search [existing issues](https://github.com/jieiku/abridge/issues).
It’s possible someone has already reported the same problem.
If your problem or idea is not addressed yet, [open a new issue](https://github.com/jieiku/abridge/issues/new).
-## Contributing
+## Contributing and Philosophy
We'd love your help! Especially with fixes to issues.
-The overall idea behind abridge is to be lightweight and fast, and to use zero javascript other than the search.
-If javascript is an absolute requirement for a feature to work then it may be added as disabled by default.
+
+The overall idea behind abridge is to be lightweight and fast, and to work properly even if javascript is disabled.
+
+The only feature that some people may consider a necessity that relies on javascript is the Search.
+
+Any feature added to abridge that relies on javascript will do so with it disabled by default.
## License
diff --git a/content/pages/about.md b/content/pages/about.md
index 8b7056e..daf125c 100644
--- a/content/pages/about.md
+++ b/content/pages/about.md
@@ -17,4 +17,4 @@ Some fun facts about the theme:
Nearly half of the existing Zola MIT themes were inspiration for features and design of this theme.
-Both the theme and this site are licensed under the [MIT license](https://opensource.org/licenses/MIT).
+Both the theme and this site are licensed under the [MIT license](https://opensource.org/licenses/MIT). \ No newline at end of file
diff --git a/content/pages/privacy.md b/content/pages/privacy.md
index 2ce5d95..18fe90f 100644
--- a/content/pages/privacy.md
+++ b/content/pages/privacy.md
@@ -10,4 +10,4 @@ template = "pages.html"
- This site does not store data in the browser to be shared, sent, or sold to third-parties.
- No personal information is shared, sent, or sold to third-parties.
-**Effective Date:** _1st Jan 2022_
+**Effective Date:** _1st Jan 2022_ \ No newline at end of file
diff --git a/templates/base.html b/templates/base.html
index db0d505..ac6356d 100644
--- a/templates/base.html
+++ b/templates/base.html
@@ -31,11 +31,11 @@
<nav>
<header>
{%- if config.extra.logo %}
- <h1><a href="{{ config.base_url | safe }}">{%- if config.extra.logo.file %}<img src="{{ config.base_url | safe }}/{{ config.extra.logo.file | safe }}" {%- if config.extra.logo.alt %}alt="{{ config.extra.logo.alt | safe }}" {%- endif %}{%- if config.extra.logo.width %}width="{{ config.extra.logo.width | safe }}" {%- endif %}{%- if config.extra.logo.height %}height="{{ config.extra.logo.height | safe }}"{%- endif %}/>{%- endif %}{%- if config.extra.logo.text %}{{ config.extra.logo.text | safe }}{%- endif %}</a></h1>
+ <h1><a href="{{ config.base_url | safe }}">{%- if config.extra.logo.file %}<img src="{{ config.base_url | safe }}/{{ config.extra.logo.file | safe }}" {%- if config.extra.logo.alt %}alt="{{ config.extra.logo.alt | safe }}" {%- endif %}{%- if config.extra.logo.width %}width="{{ config.extra.logo.width | safe }}" {%- endif %}{%- if config.extra.logo.height %}height="{{ config.extra.logo.height | safe }}"{%- endif %}/>{%- endif %}{%- if config.extra.logo.text %}{{ config.extra.logo.text | safe }}{%- endif %}</a></h1>
{%- elif config.extra.textlogo %}
- <h1><a href="{{ config.base_url | safe }}">{{ config.extra.textlogo | safe }}</a></h1>
+ <h1><a href="{{ config.base_url | safe }}">{{ config.extra.textlogo | safe }}</a></h1>
{%- elif config.title %}
- <h1><a href="{{ config.base_url | safe }}">{{ config.title | safe }}</a></h1>
+ <h1><a href="{{ config.base_url | safe }}">{{ config.title | safe }}</a></h1>
{%- endif %}
</header>
<div>
@@ -111,4 +111,4 @@
{%- endblock footer %}
<noscript><style>.searchd{display:none;}</style></noscript>
</body>
-</html>
+</html> \ No newline at end of file
diff --git a/templates/macros/macros.html b/templates/macros/macros.html
index 541ebfe..16a4e12 100644
--- a/templates/macros/macros.html
+++ b/templates/macros/macros.html
@@ -11,8 +11,7 @@
{%- endif %}
{%- if page.taxonomies.categories %} [{% for cat in page.taxonomies.categories %}<a href="{{ get_taxonomy_url(kind="categories", name=cat) | safe }}">{{ cat }}</a>{% endfor %}]{% endif %}
{%- if page.taxonomies.tags %} {%- for tag in page.taxonomies.tags %} #<a href="{{ get_taxonomy_url(kind="tags", name=tag) | safe }}">{{ tag }}</a> {% endfor -%}{%- endif %}
-{%- if config.extra.readtime %} - {{ page.reading_time }} {{ config.extra.readtime_string | default(value="min") }} {% endif %}
- </span>
+{%- if config.extra.readtime %} - {{ page.reading_time }} {{ config.extra.readtime_string | default(value="min") }} {% endif %}</span>
{%- endmacro title %}
@@ -51,23 +50,23 @@
{%- endif %}
{%- endif %}
<nav>
- <ul>
- {%- if paginator.previous %}<li><a href="{{ paginator.first | safe }}">&#124; &#60;</a></li>{% else %}<li><span class="off">&#124; &#60;</span></li>{% endif %}
- {%- if paginator.previous %}<li><a href="{{ paginator.previous | safe }}">&#60;</a></li>{% else %}<li><span class="off">&#60;</span></li>{% endif %}
- {%- for i in range(start=start, end=end+1) %}
- <li>
- {%- if i == paginator.current_index %}
- <a class="cnav" href="#">{{i}}</a>
- {%- elif i > 1 %}
- <a href="{{ paginator.base_url | safe }}{{ i ~ '/' }}">{{i}}</a>
- {%- else %}
- <a href="{{ paginator.first | safe }}">{{ i }}</a>
- {%- endif %}
- </li>
- {%- endfor %}
- {%- if paginator.next %}<li><a href="{{ paginator.next | safe }}">&#62;</a></li>{% else %}<li><span class="off">&#62;</span></li>{% endif %}
- {%- if paginator.next %}<li><a href="{{ paginator.last | safe }}">&#62; &#124;</a></li>{% else %}<li><span class="off">&#62; &#124;</span></li>{% endif %}
- </ul>
+ <ul>
+ {% if paginator.previous %}<li><a href="{{ paginator.first | safe }}">&#124; &#60;</a></li>{% else %}<li><span class="off">&#124; &#60;</span></li>{% endif %}
+ {% if paginator.previous %}<li><a href="{{ paginator.previous | safe }}">&#60;</a></li>{% else %}<li><span class="off">&#60;</span></li>{% endif %}
+ {%- for i in range(start=start, end=end+1) %}
+ <li>
+ {%- if i == paginator.current_index -%}
+ <a class="cnav" href="#">{{i}}</a>
+ {%- elif i > 1 -%}
+ <a href="{{ paginator.base_url | safe }}{{ i ~ '/' }}">{{i}}</a>
+ {%- else -%}
+ <a href="{{ paginator.first | safe }}">{{ i }}</a>
+ {%- endif -%}
+ </li>
+ {%- endfor %}
+ {% if paginator.next %}<li><a href="{{ paginator.next | safe }}">&#62;</a></li>{% else %}<li><span class="off">&#62;</span></li>{% endif %}
+ {% if paginator.next %}<li><a href="{{ paginator.last | safe }}">&#62; &#124;</a></li>{% else %}<li><span class="off">&#62; &#124;</span></li>{% endif %}
+ </ul>
</nav>
{%- endif %}
{%- endmacro %}