From 9d68a618b2b6e64a2e55f41af89ee6bf4434674d Mon Sep 17 00:00:00 2001 From: Cody Shearer Date: Sat, 6 Jan 2024 16:27:08 -0500 Subject: [PATCH] feat: add plain text output (#27) This commit adds support for a plain text output of the resume, which may be useful for submission to an ATS system. It can be found at `/index.txt`. Note that this hasn't been tested with any particular ATS system, so I make no guarantees that this will work, but it will *probably* be better than a pdf print of the website. --- .prettierignore | 5 +- .vscode/settings.json | 2 +- README.md | 8 +- content/_index.md | 42 ++-- data/plaintextreplace/LICENSE | 201 ++++++++++++++++++ .../plaintextreplace/article_txt_replace.toml | 83 ++++++++ hugo.yaml | 12 ++ layouts/_default/_markup/render-heading.html | 1 + layouts/_default/_markup/render-heading.txt | 7 + layouts/index.txt | 16 ++ layouts/shortcodes/resume/entry.html | 6 +- layouts/shortcodes/resume/entry.txt | 18 ++ 12 files changed, 370 insertions(+), 31 deletions(-) create mode 100644 data/plaintextreplace/LICENSE create mode 100644 data/plaintextreplace/article_txt_replace.toml create mode 100644 layouts/_default/_markup/render-heading.html create mode 100644 layouts/_default/_markup/render-heading.txt create mode 100644 layouts/index.txt create mode 100644 layouts/shortcodes/resume/entry.txt diff --git a/.prettierignore b/.prettierignore index 7011802..5587250 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,4 +2,7 @@ resources public static pnpm-lock.yaml -layouts/partials/imgh.html \ No newline at end of file +content/_index.md +layouts/**/*.md +layouts/partials/imgh.html +build \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index f6d302b..313f571 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,6 +1,6 @@ { "editor.codeActionsOnSave": { - "source.fixAll": true + "source.fixAll": "explicit" }, "eslint.rules.customizations": [ { diff --git a/README.md b/README.md index 56df088..9caa210 100644 --- a/README.md +++ b/README.md @@ -62,18 +62,18 @@ pnpm install ## Local Development -### - To make changes and instantly see them at http://localhost:1313, run: ```sh pnpm dev ``` -### - To create a production build, run: ```sh pnpm build ``` + +## Note + +This project contains a file `article_txt_replace.toml`, which is released under the terms of the Apache License, Version 2.0. A copy of the Apache License is available in the `data/plaintextreplace` directory of this project. Please see the Apache License for details regarding usage and distribution restrictions. diff --git a/content/_index.md b/content/_index.md index 7f54bb5..a7a5d13 100644 --- a/content/_index.md +++ b/content/_index.md @@ -1,8 +1,11 @@ --- type: resume -layout: resume +outputs: [html, txt] avatar: avatar.jpg links: + - svg: node_modules/@fortawesome/fontawesome-free/svgs/solid/globe + url: https://cjshearer.dev + name: Website - svg: node_modules/@fortawesome/fontawesome-free/svgs/brands/github url: https://github.com/cjshearer name: GitHub @@ -12,27 +15,28 @@ links: - svg: node_modules/@fortawesome/fontawesome-free/svgs/solid/envelope url: mailto:cjshearer@live.com name: Email - - svg: node_modules/@fortawesome/fontawesome-free/svgs/solid/globe - url: https://cjshearer.dev - name: Website name: Cody Shearer summary: | - Software developer with 3 years of experience in full stack web and mobile development + Software Developer with 3 Years of Experience in Full Stack Web and Mobile Development footer: | Fully typeset with HTML and CSS — see [github.com/cjshearer/modern-hugo-resume](https://github.com/cjshearer/modern-hugo-resume) skills: - languages: - - TypeScript / JavaScript - - HTML / CSS - - Go + - TypeScript + - JavaScript + - HTML + - CSS + - Golang + - Node.js - SQL + - Rust - Python - Java - - Rust - C++ - frameworks: - - React / React-Native + - React + - React-Native - Vue - Nuxt - Hugo @@ -40,9 +44,9 @@ skills: - Storybook - concepts: - Agile (Scrum) + - RESTful APIs - Material Design - - Cloud native - - Microservices + - Cloud Native - GitOps - CI/CD - tools: @@ -72,12 +76,11 @@ skills: - Improved documentation by generating server stubs, clients from OpenAPI spec - Improved onboarding and delivery with Docker and Docker Compose - Enabled rapid iteration with GitOps-driven CI/CD using GitHub Actions, CircleCI - - Improved brand alignment with custom form builders, material design systems + - Improved brand alignment with customized form builders, material design systems - Led company transition to Golang, improving performance, type-safety, and DX - Promoted culture of continuous improvement, code reviews, and linting Project Highlights: - - Developed React app, React-Native app, Node servers for equipment manufacturer - Created Bluetooth abstraction with data anomaly filtering, connection recovery - Engineered data pipeline for real-time capture and display across applications @@ -86,26 +89,22 @@ Project Highlights: - Enabled client to take ownership of project through training, documentation - Developed a Vue PWA and Go server for construction company - Reverse engineered, integrated trade management software with backend - - Enabled offline-support, prevented data loss via real-time state persistance + - Enabled offline support, prevented data loss via real-time state persistence - Developed a React SPA and Node socket server for escape room company - Created multiplayer puzzle game with draggable puzzle pieces - Designed email notification system for automated booking reminders - {{}} {{}} - - Analyzed cross-platform performance behavior of deep-learning recommender system - Reproduced results from past research on highly configurable systems - Researched relevant works on causal inference and machine learning - {{}} {{}} - Created AWS storage primitive abstracting cloud complexity for high level orchestration - Developed storage optimization solution for Amazon Elastic Block Storage - {{}} ## Education @@ -113,9 +112,8 @@ Project Highlights: {{}} - Graduated [Magna cum Laude](pdf/usc-diploma.pdf) with a mathematics minor -- Achieved [Outstanding Senior - Award](https://sc.edu/about/offices_and_divisions/leadership_and_service_center/awards_and_recognition/senior-awards/index.php) and the [Palmetto Fellows Scholarship](https://sc.edu/about/offices_and_divisions/financial_aid/scholarships/scholarships_for_sc_residents/palmetto_fellows/index.php) +- Achieved [Outstanding Senior Award](https://sc.edu/about/offices_and_divisions/leadership_and_service_center/awards_and_recognition/senior-awards/index.php) and the [Palmetto Fellows Scholarship](https://sc.edu/about/offices_and_divisions/financial_aid/scholarships/scholarships_for_sc_residents/palmetto_fellows/index.php) - Earned honors including President's List, Dean's List, and [Phi Beta Kappa](https://www.pbk.org/About) -- Served as President and Treasurer of the Carolina Movement Club (_parkour!_) +- Served as President and Treasurer of the Carolina Movement Club (*parkour!*) {{}} diff --git a/data/plaintextreplace/LICENSE b/data/plaintextreplace/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/data/plaintextreplace/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/data/plaintextreplace/article_txt_replace.toml b/data/plaintextreplace/article_txt_replace.toml new file mode 100644 index 0000000..5d35054 --- /dev/null +++ b/data/plaintextreplace/article_txt_replace.toml @@ -0,0 +1,83 @@ +# Copyright (c) 2023 Rebecca Sutton Koeser +# +# This code is derived from startwords +# (https://github.com/Princeton-CDH/startwords), which is released under the +# terms of the Apache License, Version 2.0 (the "License"); you may not use this +# file except in compliance with the License. You may obtain a copy of the +# License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +# +# Changes from source: +# - remove URLs instead of altering them +# - added replacement to remove italics, modifying the "bold" replacement to +# accommodate this method +# - removed 'heading', 'js script', 'tweet group', and 'add newline' + +# Configure regular expressions for custom article text output. +# Arguments for replaceRE, applied iteratively to .RawContent. +# Patterns with backslashes must be encapsulated within single quotes. +# Use single backslashes to escape characters. Do not use double backslashes. +# Set skip = true to skip a particular replacement. + +[[args]] +pattern = '!\[([^\]]+)\]\([^\)]+\)' +replacement = "[IMAGE: $1]" +comment = "convert markdown image" + +[[args]] +pattern = '{{\<[^\>]+>}}' +replacement = "" +comment = "remove hugo shortcodes" + +[[args]] +pattern = '(?m)(<\/?[^>]+>)' +replacement = "" +comment = "remove html tags" + +[[args]] +pattern = '(?m)^\[\^(\d+)\]: ' +replacement = "$1. " +comment = "Convert footnote label from markdown syntax to numbered list" + +[[args]] +pattern = '\[\^(\d+)\]' +replacement = '[NOTE $1]' +comment = "Convert footnote reference from markdown syntax to human readable format" + +[[args]] +pattern = '\[([^\]]+)\]\(([^\)]+)\)' +replacement = "$1" +comment = "remove markdown urls" + +[[args]] +pattern = '\*([^*]+)\*' +replacement = "$1" +comment = "remove indicators for italic text" + +[[args]] +# this works only when used after the above replacement +pattern = '\*([^*]+)\*' +replacement = "$1" +comment = "remove indicators for bold text" + +[[args]] +pattern = '{#[a-z-0-9]+}' +replacement = "" +comment = "remove custom anchor names (markdown syntax)" + +[[args]] +pattern = '\[(.+)\]\(#.*\)' +replacement = "$1" +comment = "remove anchor links within the current document" + +[[args]] +pattern = '(?ms)^\s*$(^\s*$)+' +replacement = "" +comment = "Consolidate multiple newlines" diff --git a/hugo.yaml b/hugo.yaml index 52888f7..1c840e9 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -21,6 +21,18 @@ module: target: assets - source: hugo_stats.json target: assets/watching/hugo_stats.json + - source: data + target: data + excludeFiles: plaintextreplace/LICENSE +mediaTypes: + application/text: + suffixes: + - txt +outputFormats: + TXT: + mediaType: "application/text" + baseName: "index" + isPlainText: true title: "Cody Shearer" Params: faviconEmoji: 💼 diff --git a/layouts/_default/_markup/render-heading.html b/layouts/_default/_markup/render-heading.html new file mode 100644 index 0000000..b8da9a4 --- /dev/null +++ b/layouts/_default/_markup/render-heading.html @@ -0,0 +1 @@ +{{/* Without this file, html outputs use render-heading.txt */}} diff --git a/layouts/_default/_markup/render-heading.txt b/layouts/_default/_markup/render-heading.txt new file mode 100644 index 0000000..ddfc687 --- /dev/null +++ b/layouts/_default/_markup/render-heading.txt @@ -0,0 +1,7 @@ +{{- if eq .Level 2 -}} + ------------------------------------------------------------------------------------------- +{{- else -}} + TODO: implement me if this shows up +{{- end }} +{{ .Text }} + diff --git a/layouts/index.txt b/layouts/index.txt new file mode 100644 index 0000000..1613108 --- /dev/null +++ b/layouts/index.txt @@ -0,0 +1,16 @@ +{{ .Params.name }} +------------------------------------------------------------------------------------------- +Summary + +{{ .Params.summary }} +{{ range .Params.Skills }} + {{- range $category, $items := . }} + {{- $category | strings.FirstUpper }}: {{ delimit $items ", " }} + {{- end }} +{{ end }} +{{ .Content -}} +------------------------------------------------------------------------------------------- + +{{ range .Params.links }} + {{- .name}}: {{ partial "plainTextURI.html" .url }} +{{ end }} \ No newline at end of file diff --git a/layouts/shortcodes/resume/entry.html b/layouts/shortcodes/resume/entry.html index c554129..a85ff02 100644 --- a/layouts/shortcodes/resume/entry.html +++ b/layouts/shortcodes/resume/entry.html @@ -25,9 +25,9 @@

{{ . }}

{{ . }}

{{ end }}
- {{ .Inner | markdownify }} + {{ .Inner | .Page.RenderString }}
diff --git a/layouts/shortcodes/resume/entry.txt b/layouts/shortcodes/resume/entry.txt new file mode 100644 index 0000000..704c7e1 --- /dev/null +++ b/layouts/shortcodes/resume/entry.txt @@ -0,0 +1,18 @@ +{{- $dateFormat := .Get "dateformat" | default "01/06" -}} +{{- $startDate := .Get "startdate" -}} +{{- $endDate := .Get "enddate" | default "now" -}} +{{- with $startDate -}} + {{- $startDate = time.Format $dateFormat $startDate -}} +{{- end -}} +{{- with .Get "enddate" -}} + {{- $endDate = time.Format $dateFormat . -}} +{{- end -}} +{{- $fullDate := printf "%s to %s" $startDate $endDate -}} +● {{ printf "%s, %s, %s" (.Get "name") (.Get "affiliation") $fullDate -}} +{{- $rawContent := .Inner -}} +{{- range .Site.Data.plaintextreplace.article_txt_replace.args -}} + {{- if not .skip -}} + {{- $rawContent = $rawContent | replaceRE .pattern .replacement -}} + {{- end -}} +{{- end -}} +{{- $rawContent -}}