From 472dcc301185b96fffd16746cfc2f9bfd5f9e925 Mon Sep 17 00:00:00 2001 From: earnest ma Date: Wed, 18 May 2022 10:53:32 -0400 Subject: [PATCH] chore: Update docs --- .gitignore | 3 +++ contributing.md | 14 ++++-------- ...s_48b060fe05b0a273d182ef83c0605941.content | 1 - ....css_48b060fe05b0a273d182ef83c0605941.json | 1 - ...s_48b060fe05b0a273d182ef83c0605941.content | 1 - ....css_48b060fe05b0a273d182ef83c0605941.json | 1 - license | 2 +- readme.md | 22 ++++++++----------- 8 files changed, 17 insertions(+), 28 deletions(-) create mode 100644 .gitignore delete mode 100644 exampleSite/resources/_gen/assets/css/example.org/main.css_48b060fe05b0a273d182ef83c0605941.content delete mode 100644 exampleSite/resources/_gen/assets/css/example.org/main.css_48b060fe05b0a273d182ef83c0605941.json delete mode 100644 exampleSite/resources/_gen/assets/css/main.css_48b060fe05b0a273d182ef83c0605941.content delete mode 100644 exampleSite/resources/_gen/assets/css/main.css_48b060fe05b0a273d182ef83c0605941.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2728c09 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.hugo_build.lock +exampleSite/themes +exampleSite/resources diff --git a/contributing.md b/contributing.md index 0b0b07d..6b3f05e 100644 --- a/contributing.md +++ b/contributing.md @@ -4,25 +4,19 @@ Thank you for your interest in contributing to this project! -## Bug Reports +## Bug Reports and Suggestions -Please open a new issue [here](https://git.earne.link/earnestma/dracublog/issues). +Please open a new issue [here](https://git.earne.link/earnestma/dracublog/issues) or discuss on [earne.link Discussion](https://discuss.earne.link/t/earnest). ## Style Guide See the [editor configuration file](.editorconfig) file for hints. -## Suggesting Changes - -For pull requests: - -For patches, simply [format your patch](https://git-send-email.io/) and [email it](https://www.earnestma.xyz/contact) to me (same email as `git log | grep "Author: earnest ma" -m 1`). - -If you prefer creating a pull request: +## Making Changes - [Fork the repo](https://git.earne.link/earnestma/dracublog), clone and create a branch - Add, commit your changes, push to branch -- [Create a PR](https://git.earne.link/earnestma/dracublog/pulls) targeting `develop` branch (in most cases) +- [Create a PR](https://git.earne.link/earnestma/dracublog/pulls) ## Changelog diff --git a/exampleSite/resources/_gen/assets/css/example.org/main.css_48b060fe05b0a273d182ef83c0605941.content b/exampleSite/resources/_gen/assets/css/example.org/main.css_48b060fe05b0a273d182ef83c0605941.content deleted file mode 100644 index cb45292..0000000 --- a/exampleSite/resources/_gen/assets/css/example.org/main.css_48b060fe05b0a273d182ef83c0605941.content +++ /dev/null @@ -1 +0,0 @@ -:root{--sans-font: -apple-system, BlinkMacSystemFont, "Avenir Next", Avenir, "Nimbus Sans L", Roboto, Noto, "Segoe UI", Arial, Helvetica, "Helvetica Neue", sans-serif;--mono-font: Consolas, Menlo, Monaco, "Andale Mono", "Ubuntu Mono", monospace;--base-fontsize: 1.15rem;--header-scale: 1.25;--line-height: 1.618;--bg: #282a36;--accent-bg: #282a36;--text: #f8f8f2;--text-light: #6272a4;--border: #44475a;--accent: #bd93f9;--accent-light: #bd93f9;--code: #ff79c6;--preformatted: #ccc;--marked: #f1fa8c}img,video{opacity:.6}*{font-family:var(--sans-font)}html{font-size:16px}body{color:var(--text);background:var(--bg);font-size:var(--base-fontsize);line-height:var(--line-height);margin:0}main{margin:1rem auto 0;max-width:45rem;padding:0 .5rem}header{background:var(--accent-bg);border-bottom:1px solid var(--border);padding:1.5rem 15rem;margin-bottom:3rem}@media only screen and (max-width:1200px){header{padding:1rem}nav{text-align:center}}header h1,header p{margin:0}header h2{text-align:center;line-height:1.1}nav{font-size:1rem;line-height:2;padding:1rem 0}nav a{margin:1rem 1rem 0 0;border:1px solid var(--border);border-radius:5px;color:var(--text)!important;display:inline-block;padding:.1rem 1rem;text-decoration:none;transition:.4s}nav a:hover{color:var(--accent)!important;border-color:var(--accent)}nav a.current:hover{text-decoration:none}footer{margin-top:4rem;padding:2rem 1rem 1.5rem;color:var(--text-light);font-size:.9rem;text-align:center;border-top:1px solid var(--border)}h1{font-size:calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale) * var(--header-scale) * var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}h2{font-size:calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale) * var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}h3{font-size:calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}h4{font-size:calc(var(--base-fontsize) * var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}h5{font-size:var(--base-fontsize);margin-top:calc(var(--line-height) * 1.5rem)}h6{font-size:calc(var(--base-fontsize)/var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}a,a:visited{color:var(--accent)}a:hover{text-decoration:none}a button,button,input[type=submit],input[type=reset],input[type=button]{border:none;border-radius:5px;background:var(--accent);font-size:1rem;color:var(--bg);padding:.7rem .9rem;margin:.5rem 0;transition:.4s}a button[disabled],button[disabled],input[type=submit][disabled],input[type=reset][disabled],input[type=button][disabled]{cursor:default;opacity:.5;cursor:not-allowed}abbr{cursor:help}button:focus,button:enabled:hover,input[type=submit]:focus,input[type=submit]:enabled:hover,input[type=reset]:focus,input[type=reset]:enabled:hover,input[type=button]:focus,input[type=button]:enabled:hover{opacity:.8}details{padding:.6rem 1rem;background:var(--accent-bg);border:1px solid var(--border);border-radius:5px;margin-bottom:1rem}summary{cursor:pointer;font-weight:700}details[open]{padding-bottom:.75rem}details[open] summary{margin-bottom:.5rem}details[open]>*:last-child{margin-bottom:0}table{border-collapse:collapse;width:100%}td,th{border:1px solid var(--border);text-align:left;padding:.5rem}th{background:var(--accent-bg);font-weight:700}tr:nth-child(even){background:var(--accent-bg)}table caption{font-weight:700;margin-bottom:.5rem}ol,ul{padding-left:3rem}textarea,select,input{font-size:inherit;font-family:inherit;padding:.5rem;margin-bottom:.5rem;color:var(--text);background:var(--bg);border:1px solid var(--border);border-radius:5px;box-shadow:none;box-sizing:border-box;width:60%}textarea{width:80%}@media only screen and (max-width:720px){textarea,select,input{width:100%}}input[type=checkbox],input[type=radio]{width:auto}input[type=file]{border:0}fieldset{border:0;padding:0;margin:0}hr{color:var(--border);border-top:1px;margin:1rem auto}mark{padding:2px 5px;border-radius:4px;background:var(--marked)}main img,main video{max-width:100%;border-radius:5px}figure{margin:0}figcaption{font-size:.9rem;color:var(--text-light);text-align:center;margin-bottom:1rem}blockquote{margin:2rem 0 2rem 2rem;padding:.4rem .8rem;border-left:.35rem solid var(--accent);opacity:.8;font-style:italic}cite{font-size:.9rem;color:var(--text-light);font-style:normal}code,pre,kbd,samp{font-size:1.075rem;font-family:var(--mono-font);color:var(--code)}kbd{color:var(--preformatted);border:1px solid var(--preformatted);border-bottom:3px solid var(--preformatted);border-radius:5px;padding:.1rem}pre{padding:1rem 1.4rem;max-width:100%;overflow:auto;color:var(--preformatted);background:var(--accent-bg);border:1px solid var(--border);border-radius:5px}pre code{color:var(--preformatted);background:0 0;margin:0;padding:0}.webring{margin-top:2rem}.wr-articles{display:flex}@media(max-width:640px){.wr-articles{flex-direction:column}}.wr-article{flex:1 1 0;display:flex;flex-direction:column;background:#323542;padding:.5rem;margin:0 .5rem}@media(max-width:640px){.wr-article{margin:.5rem 0}}.wr-article:first-child{margin-left:0}.wr-article:last-child{margin-right:0}.wr-summary{font-size:.8rem;flex:1 1 0;color:#ebebeb}.wr-attribution{float:right;font-size:.8rem;color:#c0bfbf;line-height:3}.wr-date{color:#c0bfbf}.wr-source{color:#c0bfbf}.mastodon-comment{background-color:var(--body-background);border-radius:var(--card-border-radius);padding:var(--card-padding);margin-bottom:1rem;display:flex}.mastodon-comment .content{flex-grow:2}.mastodon-comment .avatar img{margin-right:1rem;min-width:60px}.mastodon-comment .author{padding-top:0;display:flex}.mastodon-comment .author .date{margin-left:auto}.mastodon-comment .disabled{color:var(--accent-color)}.mastodon-comment-content p:first-child{margin-top:0} \ No newline at end of file diff --git a/exampleSite/resources/_gen/assets/css/example.org/main.css_48b060fe05b0a273d182ef83c0605941.json b/exampleSite/resources/_gen/assets/css/example.org/main.css_48b060fe05b0a273d182ef83c0605941.json deleted file mode 100644 index ecf9eea..0000000 --- a/exampleSite/resources/_gen/assets/css/example.org/main.css_48b060fe05b0a273d182ef83c0605941.json +++ /dev/null @@ -1 +0,0 @@ -{"Target":"main.min.2700adb3e3573b5490a0c66bf3eca5392a7adccce620f5752baf8f8a11e1188d.css","MediaType":"text/css","Data":{"Integrity":"sha256-JwCts+NXO1SQoMZr8+ylOSp63MzmIPV1K6+PihHhGI0="}} \ No newline at end of file diff --git a/exampleSite/resources/_gen/assets/css/main.css_48b060fe05b0a273d182ef83c0605941.content b/exampleSite/resources/_gen/assets/css/main.css_48b060fe05b0a273d182ef83c0605941.content deleted file mode 100644 index cb45292..0000000 --- a/exampleSite/resources/_gen/assets/css/main.css_48b060fe05b0a273d182ef83c0605941.content +++ /dev/null @@ -1 +0,0 @@ -:root{--sans-font: -apple-system, BlinkMacSystemFont, "Avenir Next", Avenir, "Nimbus Sans L", Roboto, Noto, "Segoe UI", Arial, Helvetica, "Helvetica Neue", sans-serif;--mono-font: Consolas, Menlo, Monaco, "Andale Mono", "Ubuntu Mono", monospace;--base-fontsize: 1.15rem;--header-scale: 1.25;--line-height: 1.618;--bg: #282a36;--accent-bg: #282a36;--text: #f8f8f2;--text-light: #6272a4;--border: #44475a;--accent: #bd93f9;--accent-light: #bd93f9;--code: #ff79c6;--preformatted: #ccc;--marked: #f1fa8c}img,video{opacity:.6}*{font-family:var(--sans-font)}html{font-size:16px}body{color:var(--text);background:var(--bg);font-size:var(--base-fontsize);line-height:var(--line-height);margin:0}main{margin:1rem auto 0;max-width:45rem;padding:0 .5rem}header{background:var(--accent-bg);border-bottom:1px solid var(--border);padding:1.5rem 15rem;margin-bottom:3rem}@media only screen and (max-width:1200px){header{padding:1rem}nav{text-align:center}}header h1,header p{margin:0}header h2{text-align:center;line-height:1.1}nav{font-size:1rem;line-height:2;padding:1rem 0}nav a{margin:1rem 1rem 0 0;border:1px solid var(--border);border-radius:5px;color:var(--text)!important;display:inline-block;padding:.1rem 1rem;text-decoration:none;transition:.4s}nav a:hover{color:var(--accent)!important;border-color:var(--accent)}nav a.current:hover{text-decoration:none}footer{margin-top:4rem;padding:2rem 1rem 1.5rem;color:var(--text-light);font-size:.9rem;text-align:center;border-top:1px solid var(--border)}h1{font-size:calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale) * var(--header-scale) * var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}h2{font-size:calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale) * var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}h3{font-size:calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}h4{font-size:calc(var(--base-fontsize) * var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}h5{font-size:var(--base-fontsize);margin-top:calc(var(--line-height) * 1.5rem)}h6{font-size:calc(var(--base-fontsize)/var(--header-scale));margin-top:calc(var(--line-height) * 1.5rem)}a,a:visited{color:var(--accent)}a:hover{text-decoration:none}a button,button,input[type=submit],input[type=reset],input[type=button]{border:none;border-radius:5px;background:var(--accent);font-size:1rem;color:var(--bg);padding:.7rem .9rem;margin:.5rem 0;transition:.4s}a button[disabled],button[disabled],input[type=submit][disabled],input[type=reset][disabled],input[type=button][disabled]{cursor:default;opacity:.5;cursor:not-allowed}abbr{cursor:help}button:focus,button:enabled:hover,input[type=submit]:focus,input[type=submit]:enabled:hover,input[type=reset]:focus,input[type=reset]:enabled:hover,input[type=button]:focus,input[type=button]:enabled:hover{opacity:.8}details{padding:.6rem 1rem;background:var(--accent-bg);border:1px solid var(--border);border-radius:5px;margin-bottom:1rem}summary{cursor:pointer;font-weight:700}details[open]{padding-bottom:.75rem}details[open] summary{margin-bottom:.5rem}details[open]>*:last-child{margin-bottom:0}table{border-collapse:collapse;width:100%}td,th{border:1px solid var(--border);text-align:left;padding:.5rem}th{background:var(--accent-bg);font-weight:700}tr:nth-child(even){background:var(--accent-bg)}table caption{font-weight:700;margin-bottom:.5rem}ol,ul{padding-left:3rem}textarea,select,input{font-size:inherit;font-family:inherit;padding:.5rem;margin-bottom:.5rem;color:var(--text);background:var(--bg);border:1px solid var(--border);border-radius:5px;box-shadow:none;box-sizing:border-box;width:60%}textarea{width:80%}@media only screen and (max-width:720px){textarea,select,input{width:100%}}input[type=checkbox],input[type=radio]{width:auto}input[type=file]{border:0}fieldset{border:0;padding:0;margin:0}hr{color:var(--border);border-top:1px;margin:1rem auto}mark{padding:2px 5px;border-radius:4px;background:var(--marked)}main img,main video{max-width:100%;border-radius:5px}figure{margin:0}figcaption{font-size:.9rem;color:var(--text-light);text-align:center;margin-bottom:1rem}blockquote{margin:2rem 0 2rem 2rem;padding:.4rem .8rem;border-left:.35rem solid var(--accent);opacity:.8;font-style:italic}cite{font-size:.9rem;color:var(--text-light);font-style:normal}code,pre,kbd,samp{font-size:1.075rem;font-family:var(--mono-font);color:var(--code)}kbd{color:var(--preformatted);border:1px solid var(--preformatted);border-bottom:3px solid var(--preformatted);border-radius:5px;padding:.1rem}pre{padding:1rem 1.4rem;max-width:100%;overflow:auto;color:var(--preformatted);background:var(--accent-bg);border:1px solid var(--border);border-radius:5px}pre code{color:var(--preformatted);background:0 0;margin:0;padding:0}.webring{margin-top:2rem}.wr-articles{display:flex}@media(max-width:640px){.wr-articles{flex-direction:column}}.wr-article{flex:1 1 0;display:flex;flex-direction:column;background:#323542;padding:.5rem;margin:0 .5rem}@media(max-width:640px){.wr-article{margin:.5rem 0}}.wr-article:first-child{margin-left:0}.wr-article:last-child{margin-right:0}.wr-summary{font-size:.8rem;flex:1 1 0;color:#ebebeb}.wr-attribution{float:right;font-size:.8rem;color:#c0bfbf;line-height:3}.wr-date{color:#c0bfbf}.wr-source{color:#c0bfbf}.mastodon-comment{background-color:var(--body-background);border-radius:var(--card-border-radius);padding:var(--card-padding);margin-bottom:1rem;display:flex}.mastodon-comment .content{flex-grow:2}.mastodon-comment .avatar img{margin-right:1rem;min-width:60px}.mastodon-comment .author{padding-top:0;display:flex}.mastodon-comment .author .date{margin-left:auto}.mastodon-comment .disabled{color:var(--accent-color)}.mastodon-comment-content p:first-child{margin-top:0} \ No newline at end of file diff --git a/exampleSite/resources/_gen/assets/css/main.css_48b060fe05b0a273d182ef83c0605941.json b/exampleSite/resources/_gen/assets/css/main.css_48b060fe05b0a273d182ef83c0605941.json deleted file mode 100644 index ecf9eea..0000000 --- a/exampleSite/resources/_gen/assets/css/main.css_48b060fe05b0a273d182ef83c0605941.json +++ /dev/null @@ -1 +0,0 @@ -{"Target":"main.min.2700adb3e3573b5490a0c66bf3eca5392a7adccce620f5752baf8f8a11e1188d.css","MediaType":"text/css","Data":{"Integrity":"sha256-JwCts+NXO1SQoMZr8+ylOSp63MzmIPV1K6+PihHhGI0="}} \ No newline at end of file diff --git a/license b/license index 623828f..85e98c8 100644 --- a/license +++ b/license @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2021 earnest ma +Copyright (c) 2021-2022 earnest ma Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/readme.md b/readme.md index 7191927..450e5be 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,6 @@ -# [Dracublog](https://earnestma.xyz/dracublog) +# Dracublog [![git repo](https://img.shields.io/badge/repo-git-informational.svg?logo=gitea)](https://git.earne.link/earnestma/dracublog) -[![GitHub mirror](https://img.shields.io/badge/mirror-GitHub-black.svg?logo=github)](https://github.com/earnestma/dracublog) A simple, fully-featured Hugo blogging theme with Dracula colors. @@ -14,22 +13,19 @@ Features: - Optional openring styling (generates a list of recent posts from blogs you follow) - `noindex` param to prevent certain pages from being indexed -**Demo**: - - -[My personal site](https://earnestma.xyz) uses this theme. - ## Install -- Git submodule +**Tarball** + +- Version: `https://git.earne.link/earnestma/dracublog/archive/$VERSION.tar.gz` +- Main branch: `https://git.earne.link/earnestma/dracublog/archive/main.tar.gz` + +You can add `themes/dracublog` to `.gitignore`, and extract it there. + +**Through a git submodule** `git submodule add https://git.earne.link/earnestma/dracublog.git themes/dracublog` -The `main` branch will always point to the latest stable tag. To track the develop branch, you may instead use `git submodule add https://git.earne.link/earnestma/dracublog.git themes/dracublog -b develop` - -- Release - -Regular and minified release tarbells are available: **[here](https://git.earne.link/earnestma/dracublog/releases)** and [on GitHub releases](https://github.com/earnestma/dracublog/releases). Simply uncompress to the themes directory. - ## Configuration ## Gemini Output