From 2ef7c0ec1ff976b807691fea23eaaf5ea1e93bc9 Mon Sep 17 00:00:00 2001 From: Jieiku Date: Sun, 27 Mar 2022 19:19:28 -0700 Subject: init --- LICENSE | 21 ++ README.md | 3 + config.toml | 78 +++++ content/_index.md | 4 + content/overview-abridge.md | 23 ++ content/overview-embedded-videos.md | 23 ++ content/overview-images/image.jpg | Bin 0 -> 123922 bytes content/overview-images/index.md | 26 ++ content/overview-images/rust.png | Bin 0 -> 14303 bytes content/overview-markdown-syntax.md | 161 +++++++++ content/overview-math.md | 91 +++++ content/overview-rich-content.md | 90 +++++ content/pages/_index.md | 3 + content/pages/about.md | 20 ++ content/pages/contact.md | 5 + content/pages/privacy.md | 11 + content/posts/_index.md | 4 + highlight_themes/Midnight.dark.tmTheme | 593 +++++++++++++++++++++++++++++++++ sass/_variables.scss | 88 +++++ sass/abridge.scss | 42 +++ sass/include/_button.scss | 41 +++ sass/include/_code.scss | 33 ++ sass/include/_document.scss | 37 ++ sass/include/_embedded.scss | 19 ++ sass/include/_form.scss | 36 ++ sass/include/_grid.scss | 14 + sass/include/_hr.scss | 15 + sass/include/_icons.scss | 102 ++++++ sass/include/_misc.scss | 15 + sass/include/_nav.scss | 62 ++++ sass/include/_recent.scss | 35 ++ sass/include/_scroller.scss | 17 + sass/include/_sectioning.scss | 87 +++++ sass/include/_table.scss | 30 ++ sass/include/_toc.scss | 44 +++ sass/include/_typography.scss | 136 ++++++++ sass/themes/_auto.scss | 100 ++++++ sass/themes/_dark.scss | 89 +++++ sass/themes/_light.scss | 89 +++++ screenshot.png | Bin 0 -> 188541 bytes templates/404.html | 18 + templates/base.html | 128 +++++++ templates/categories/list.html | 12 + templates/categories/single.html | 8 + templates/contact.html | 16 + templates/index.html | 17 + templates/macros/macros.html | 7 + templates/macros/page.html | 3 + templates/macros/social.html | 23 ++ templates/page.html | 40 +++ templates/pages.html | 2 + templates/posts.html | 5 + templates/robots.txt | 4 + templates/shortcodes/audio.html | 7 + templates/shortcodes/gif.html | 7 + templates/shortcodes/image.html | 7 + templates/shortcodes/img.html | 42 +++ templates/shortcodes/katex.html | 1 + templates/shortcodes/quote.html | 6 + templates/shortcodes/video.html | 7 + templates/shortcodes/vm.html | 3 + templates/shortcodes/yt.html | 3 + templates/tags/list.html | 11 + templates/tags/single.html | 8 + theme.toml | 12 + 65 files changed, 2684 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 config.toml create mode 100644 content/_index.md create mode 100644 content/overview-abridge.md create mode 100644 content/overview-embedded-videos.md create mode 100644 content/overview-images/image.jpg create mode 100644 content/overview-images/index.md create mode 100644 content/overview-images/rust.png create mode 100644 content/overview-markdown-syntax.md create mode 100644 content/overview-math.md create mode 100644 content/overview-rich-content.md create mode 100644 content/pages/_index.md create mode 100644 content/pages/about.md create mode 100644 content/pages/contact.md create mode 100644 content/pages/privacy.md create mode 100644 content/posts/_index.md create mode 100644 highlight_themes/Midnight.dark.tmTheme create mode 100644 sass/_variables.scss create mode 100644 sass/abridge.scss create mode 100644 sass/include/_button.scss create mode 100644 sass/include/_code.scss create mode 100644 sass/include/_document.scss create mode 100644 sass/include/_embedded.scss create mode 100644 sass/include/_form.scss create mode 100644 sass/include/_grid.scss create mode 100644 sass/include/_hr.scss create mode 100644 sass/include/_icons.scss create mode 100644 sass/include/_misc.scss create mode 100644 sass/include/_nav.scss create mode 100644 sass/include/_recent.scss create mode 100644 sass/include/_scroller.scss create mode 100644 sass/include/_sectioning.scss create mode 100644 sass/include/_table.scss create mode 100644 sass/include/_toc.scss create mode 100644 sass/include/_typography.scss create mode 100644 sass/themes/_auto.scss create mode 100644 sass/themes/_dark.scss create mode 100644 sass/themes/_light.scss create mode 100644 screenshot.png create mode 100644 templates/404.html create mode 100644 templates/base.html create mode 100644 templates/categories/list.html create mode 100644 templates/categories/single.html create mode 100644 templates/contact.html create mode 100644 templates/index.html create mode 100644 templates/macros/macros.html create mode 100644 templates/macros/page.html create mode 100644 templates/macros/social.html create mode 100644 templates/page.html create mode 100644 templates/pages.html create mode 100644 templates/posts.html create mode 100644 templates/robots.txt create mode 100644 templates/shortcodes/audio.html create mode 100644 templates/shortcodes/gif.html create mode 100644 templates/shortcodes/image.html create mode 100644 templates/shortcodes/img.html create mode 100644 templates/shortcodes/katex.html create mode 100644 templates/shortcodes/quote.html create mode 100644 templates/shortcodes/video.html create mode 100644 templates/shortcodes/vm.html create mode 100644 templates/shortcodes/yt.html create mode 100644 templates/tags/list.html create mode 100644 templates/tags/single.html create mode 100644 theme.toml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7cbaff8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Jake G (https://github.com/Jieiku) + +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 the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..690e0ca --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Abridge Zola Theme + +[abridge](https://github.com/jieiku/abridge) is a fast and lightweight Zola theme using semantic html, class-light [abridge.css](https://github.com/jieiku/abridge.css), and No JS. diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..f591494 --- /dev/null +++ b/config.toml @@ -0,0 +1,78 @@ +base_url = "https://jieiku.github.io/abridge/" +title = "abridge - Zola Theme" +description = "abridge is a fast and lightweight Zola theme using semantic html, abridge.css class-light CSS, and No JS." +default_language = "en" +#theme = "abridge" + +output_dir = "public" +compile_sass = true +build_search_index = false +minify_html = false +generate_feed = true +feed_filename = "atom.xml" +#ignored_content = ["*.{graphml,xlsx}", "temp.*"] +#hard_link_static = false # set to true to hard link instead of copying, useful for very large files. +taxonomies = [ + {name = "categories", feed = true}, + {name = "tags", feed = true}, +] + +[markdown] +extra_syntaxes_and_themes = ["highlight_themes"] +highlight_code = true +highlight_theme = "material-dark" # OneHalfDark, material-dark, ayu-dark, Midnight.dark +#highlight_theme = "css" # use css classes - https://www.getzola.org/documentation/content/syntax-highlighting/#inline-vs-classed-highlighting +render_emoji = false +external_links_target_blank = true # rel="noopener" +external_links_no_follow = false # rel="nofollow" +external_links_no_referrer = false # rel="noreferrer" +smart_punctuation = false # `...` to `…`, `"quote"` to `“curly”` etc + +[extra] +katex_enable = false # used to to render mathematical notations, requires js +recent = true +recent_items = 9 +footer_credit = true +#google = "Your Google Site verification code." +#bing = "Your Bing Site verification code." +textlogo = 'Abridge' +sitedesc = false # This enables or disables the display of the site description below the logo. +author = "Your Name" +keywords = "Whatever, SEO, keywords, you want" +banner = "banner.png" +menu = [ + {url = "/", name = "Home", slash = true}, + {url = "/about/", name = "About", slash = true}, + {url = "/posts/", name = "Posts", slash = true}, + {url = "/categories/", name = "Categories", slash = true}, + {url = "/tags/", name = "Tags", slash = true}, +] +menu_footer = [ + {url = "/", name = "Home", slash = true}, + {url = "/about/", name = "About", slash = true}, + {url = "/contact/", name = "Contact", slash = true}, + {url = "/privacy/", name = "Privacy", slash = true}, + {url = "/sitemap.xml", name = "Sitemap", slash = false}, +] + +# Footer social links; full options listed in macros/social.html +[extra.social] +mail = "name@example.com" +mastodon = "@your-user-name" +element = "matrix.example.com" +#matrix = "matrix.example.com" +twitter = "your-user-name" +facebook = "your-user-name" +linkedin = "your-user-name" + +gitlab = "your-user-name" +github = "your-user-name" +bitbucket = "your-user-name" +python = "your-user-name" +docker = "your-user-name" +stack = "your-user-name" + +instagram = "your-user-name" +pinterest = "your-user-name" +twitch = "your-user-name" +youtube = "your-channel-id" diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..3511f76 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,4 @@ ++++ +paginate_by = 3 +sort_by = "date" ++++ diff --git a/content/overview-abridge.md b/content/overview-abridge.md new file mode 100644 index 0000000..51beea6 --- /dev/null +++ b/content/overview-abridge.md @@ -0,0 +1,23 @@ ++++ +title = "Abridge Zola theme and css framework" +date = 2021-05-10 + +[taxonomies] +categories = ["Features"] +tags = ["theme","config"] ++++ + +For quick setup copy the config.toml from the abridge theme into the root of your zola site, this will give you a base configuration with all config values used. + +You can then edit or comment out the values in this file as necessary. + +You should also uncomment out the line #theme = "abridge" in your root zola config.toml file. This tells your root zola site to use the abridge theme in the themes folder. + +You can set the number of items that appear on the home page by editing `themes\abridge\content\_index.md` file and adjusting `paginate_by = 5` + +You can set the overal page width by editing `themes\abridge\sass\_variables.scss` file, and adjusting these two lines: + +```scss +$mw:50% !default;// max-width +$mb:1200px !default;// value at which to switch from fluid layout to using max-width +``` diff --git a/content/overview-embedded-videos.md b/content/overview-embedded-videos.md new file mode 100644 index 0000000..aa9074e --- /dev/null +++ b/content/overview-embedded-videos.md @@ -0,0 +1,23 @@ ++++ +title = "Embedded Youtube & Vimeo Videos" +date = 2021-05-07 + +[taxonomies] +categories = ["Features"] +tags = ["shortcodes","video"] ++++ + +Zola has many shortcodes, and new are easily added, this example shows vimeo and youtube. + + +## Vimeo + +with `vm(id="id_here")` + +{{ vm(id="514402648") }} + +## Youtube + +with `yt(id="the_id_here")` + +{{ yt(id="32gyFIWecuw") }} diff --git a/content/overview-images/image.jpg b/content/overview-images/image.jpg new file mode 100644 index 0000000..7b9e98d Binary files /dev/null and b/content/overview-images/image.jpg differ diff --git a/content/overview-images/index.md b/content/overview-images/index.md new file mode 100644 index 0000000..0e623e5 --- /dev/null +++ b/content/overview-images/index.md @@ -0,0 +1,26 @@ ++++ +title = "Images, Direct and Relative Path" +date = 2021-05-08 + +[taxonomies] +categories = ["Features"] +tags = ["images"] ++++ + +Images can be embed using direct or relative paths. + +Use `img()` to specify the relative path of image: + +{{ img(path="./image.jpg", alt="") }} + +This is an example note with direct image, without using shortcode: + +![Rust](rust.png) + +This is an svg image: + + + + diff --git a/content/overview-images/rust.png b/content/overview-images/rust.png new file mode 100644 index 0000000..38cbc4f Binary files /dev/null and b/content/overview-images/rust.png differ diff --git a/content/overview-markdown-syntax.md b/content/overview-markdown-syntax.md new file mode 100644 index 0000000..0a49a81 --- /dev/null +++ b/content/overview-markdown-syntax.md @@ -0,0 +1,161 @@ ++++ +title = "Markdown Syntax Guide" +description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements." +date = 2021-05-09 + +[taxonomies] +categories = ["Features"] +tags = ["Markdown"] +[extra] +toc = true ++++ + +This article offers a sample of basic Markdown syntax that can be used in Zola content files, also it shows if basic HTML elements are decorated with CSS in a Zola theme. + +## Headings + +The following HTML `

`—`

` elements represent six levels of section +headings. `

` is the highest section level while `

` is the lowest. + +# H1 +## H2 +### H3 +#### H4 +##### H5 +###### H6 + +## Paragraph + +Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, +voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma +dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as +cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin +porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? +Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit +ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda +veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore +eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata +tiustia prat. + +Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne +sapicia is sinveli squiatum, core et que aut hariosam ex eat. + +## Blockquotes + +The blockquote element represents content that is quoted from another source, +optionally with a citation which must be within a `footer` or `cite` element, +and optionally with in-line changes such as annotations and abbreviations. + +#### Blockquote without attribution + +> Tiam, ad mint andaepu dandae nostion secatur sequo quae. +> **Note** that you can use *Markdown syntax* within a blockquote. + +#### Blockquote with attribution + +> Don't communicate by sharing memory, share memory by communicating.
+> — Rob Pike[^1] + +> All men by nature desire to know.
+> ― Aristotle[^2] + +## Tables + +Tables aren't part of the core Markdown spec, but Zola supports them +out-of-the-box. + + Name | Age +--------|------ + Alice | 23 + Bob | 27 + Cody | 33 + John | 59 + Kerry | 23 + +#### Inline Markdown within tables + +| Italics | Bold | Code | StrikeThrough | +| -------- | -------- | ------ | ----------------- | +| *italics* | **bold** | `code` | ~~strikethrough~~ | + +## Foldable Text + +
+ Title 1 +

IT'S A SECRET TO EVERYBODY.

+
+ +
+ Title 2 +

Stay awhile, and listen!

+
+ +## Code Blocks + +Code blocks.. ❤️ with automatic syntax highlighting ✨‍ + +See [the docs](https://www.getzola.org/documentation/content/syntax-highlighting/) for options. + +#### Code block with backticks + +```html + + + + + Example HTML5 Document + + +

Test

+ + +``` + +#### Inline Code block + +If we want, we can also `specify inline code` which is useful for `the small stuff`. + +## List Types + +#### Ordered List + +1. First item +2. Second item +3. Third item + +#### Unordered List + +- List item +- Another item +- And another item + +#### Nested list + +- Fruit + - Apple + - Orange + - Banana +- Dairy + - Milk + - Cheese + +## Other Elements — abbr, sub, sup, kbd, mark, link + +GIF is a bitmap image format. + +H2O + +Xn + Yn = Zn + +Press CTRL+ALT+Delete to end the +session. + +Most salamanders are nocturnal, and hunt for insects, worms, and +other small creatures. + +--- + +[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) +during Gopherfest, November 18, 2015. + +[^2]: The quote is the first sentence of Aristotle's [Metaphysics](https://en.wikipedia.org/wiki/Metaphysics_(Aristotle)). diff --git a/content/overview-math.md b/content/overview-math.md new file mode 100644 index 0000000..df1b8b4 --- /dev/null +++ b/content/overview-math.md @@ -0,0 +1,91 @@ ++++ +title = "Mathematical Notations Support" +date = 2021-05-05 +updated = 2022-01-01 +[taxonomies] +categories = ["Features"] +tags = ["KaTeX", "Mathematics"] +[extra] +math = true ++++ + +You can use [$\KaTeX$](https://katex.org) to render mathematical notations. + +You can enable the $\KaTeX$ support globally, per-section or per-page basis. + +### Enable Globally + +To enable the $\KaTeX$ support globally, add `math = true` under `[extra]` of the `config.toml` +at your site root. Now every section and page of your site will load the KaTeX [autorender extension](https://katex.org/docs/autorender.html). + +```toml +[extra] +math = true +``` + +### Per-section Basis + +To enable the $\KaTeX$ support in a particular section, add `math = true` under `[extra]` in the `[SECTION_NAME]/_index.md`. Now every page under this section will load the KaTeX +[autorender extension](https://katex.org/docs/autorender.html). + +```md ++++ +[extra] +math = true ++++ +``` + +### Per-page Basis + +To enable the $\KaTeX$ support in a particular page, add `math = true` under `[extra]` in the page's +frontmatter. Now this page will load the $\KaTeX$ [autorender extension](https://katex.org/docs/autorender.html). + +```markdown ++++ +[extra] +math = true ++++ +``` + +It is a good practice to enable $\KaTeX$ support on a per-page basis, since this will only load the +required files on that particular page, without affecting the page load speed of other pages. +If your site is not math-heavy, please do NOT enable this feature globally or per-section basis. + +## Usage + +Wrap any [valid](https://katex.org/docs/supported.html) $\KaTeX$ syntax with `$...$` for inline +Mathematics and `$$...$$` for block Mathematics. + +### Inline Mathematics + +This is the most beautiful equation I've ever seen: + +``` +$e^{i\pi}+1=0$ +``` +$e^{i\pi}+1=0$ + +### Block Mathematics + +Some Mathematics in display mode is fair enough: + +``` +$$ +\int_0^1 x^2 dx +$$ +``` +$$ +\int_0^1 x^2 dx +$$ + +### Another Example + +``` +$$ +f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi +$$ +``` + +$$ +f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi +$$ diff --git a/content/overview-rich-content.md b/content/overview-rich-content.md new file mode 100644 index 0000000..b511713 --- /dev/null +++ b/content/overview-rich-content.md @@ -0,0 +1,90 @@ ++++ +title = "Rich Content" +description = "A brief description of Zola Shortcodes" +date = 2021-05-06 + +[taxonomies] +categories = ["Features"] +tags = ["video", "audio", "images", "shortcodes"] +[extra] +toc = true ++++ + +Several custom shortcodes are included to augment CommonMark (courtesy of d3c3nt theme), in addition to those [already provided by Zola][built-in]. `video`, `image`, `gif`, and `audio` were created to help you take advantage of modern HTML elements in your writing. + + + +## Video + +The `video` shortcode takes a `sources` parameter (an array of strings) +and returns a `