jekyll-dewey-decimal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d758e90f3e75745468b14718af6ad742e0e65ad414c527fd3fd524710f59256b
+  data.tar.gz: 44c78ec7621254a30e6aa1c8d432c550bf40374f049528a4013f8c8a41f1e9d7
+SHA512:
+  metadata.gz: 15580cd83b7118b7755f0d33765f91d0bd5f03e1b21184c26b4bdd4c409e9b676ea13bca11f5957796f725e565212b0ea29f8d772fc61cdde4a38fe8b4cbfcfa
+  data.tar.gz: 36bdb665eb9206c47fd24da424f6e84294ea763db1e357a581161d5b286e89c49e5f6049ae1a73903fb9678ad1c5afcecb2d97709943f7a145c43050d88681f0

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "rouge", "~> 4.2"

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    jekyll-dewey-decimal (0.1.0)
+      jekyll (~> 4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.2.2)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.16.3)
+    forwardable-extended (2.6.0)
+    google-protobuf (3.25.1-x86_64-darwin)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (5.0.4)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.6)
+    rouge (4.2.0)
+    safe_yaml (1.0.5)
+    sass-embedded (1.69.5-x86_64-darwin)
+      google-protobuf (~> 3.23)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  x86_64-darwin-23
+
+DEPENDENCIES
+  jekyll-dewey-decimal!
+  rouge (~> 4.2)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Revati Tambe
+
+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.

data/README.md

@@ -0,0 +1,62 @@
+# jekyll-dewey-decimal
+
+📖 A content-first, minimal personal weblog and portfolio.
+
+![Screenshot](https://raw.githubusercontent.com/djarty24/jekyll-dewey-decimal/master/screenshot.png)
+
+## Contents
+- [Installation](#installation)
+- [Customizing](#customizing)
+- [Page Layouts](#page-layouts)
+- [Site Settings](#site-settings)
+- [License](#license)
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-dewey-decimal"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-simple-blue
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-dewey-decimal
+
+## Customizing
+
+Using dewey as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings.
+
+To add your own styles copy the [`styles.css`](https://github.com/djarty24/jekyll-dewey-decimal/raw/main/assets/styles.css) into your own project with the same file path (`assets/styles.css`). From there you can add your own styles, and modify or even remove existing ones.
+
+## Page-Layouts
+
+There are 3 layouts; `page`, `post`, and `home` (home acts as the front page blog).
+
+## Site-Settings
+
+To modify set parameters, you need to modify the `_config.yml` `title` and `url`.
+
+Additionally, you need to add the following parameters to edit the author name and email.
+
+```yaml
+author:
+    name: Your name
+    email: Your email
+```
+
+To add your resume, favicon, and a custom profile photo, simply copy them into the root folder with the names `resume.pdf`, `favicon.ico`, and `profile.png`.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_config.yml

@@ -0,0 +1,12 @@
+title: SITE_TITLE
+description: SITE_DESCRIPTION
+author:
+  name: AUTHOR_NAME
+  email: EMAIL@EXAMPLE.COM
+copyright_year: YEAR
+
+markdown: kramdown
+
+kramdown:
+  input: GFM
+  syntax_highlighter: rouge

data/_includes/footer.html

@@ -0,0 +1,6 @@
+<footer class="footer">
+    <p class="copyright">
+      &copy; {{ site.copyright_year }}.
+      Made with ♡ by <a href="mailto:{{ site.author.email }}" class="hard-anchor" title="mailto">{{ site.author.name }}</a> All rights reserved.
+    </p>
+</footer>

data/_includes/header.html

@@ -0,0 +1,27 @@
+<!-- <div class="header-container">
+    <nav>
+        <div class="nav-left">
+            <ul>
+                <li><a href="{{ '/' | relative_url }}">{{ site.title }}</a></li>
+            </ul>
+        </div>
+        <div class="nav-right">
+            <ul>
+                <li><a href="{{ '/about' | relative_url }}">About</a></li>
+                <li><a href="/resume.pdf" target="_blank">Resumé</a></li>
+                <li><a href="{{ '/contact' | relative_url }}">Contact</a></li> 
+            </ul>
+        </div>    
+    </nav>
+</div> -->
+
+<div class="header-container">
+    <ul class="nav-left">
+        <li><a href="{{ '/' | relative_url }}">{{ site.title }}</a></li>
+    </ul>
+    <ul class="nav-right">
+        <li><a href="{{ '/about' | relative_url }}" style="padding-left: 20px;">About</a></li>
+        <li><a href="/resume.pdf" target="_blank" style="padding-left: 20px;">Resumé</a></li>
+        <li><a href="{{ '/contact' | relative_url }}" style="padding-left: 20px;">Contact</a></li> 
+    </ul>
+</div>

data/_includes/post-list.html

@@ -0,0 +1,11 @@
+<div class="post-list-container">
+    <h2>Blog posts</h2>
+    <ul class="posts-list">
+    {% for post in site.posts %}
+        <li>
+        <span class="post-date" style="color: #696969;">{{ post.date | date_to_string }} »</span>
+        <a href="{{ post.url }}" class="caption" title="🔖 {{ post.tags | array_to_sentence_string }}">{{post.title}}</a>
+        </li>
+    {% endfor %}
+    </ul>
+</div>

data/_layouts/default.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <link rel="preconnect" href="https://fonts.googleapis.com">
+        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+        <link href="https://fonts.googleapis.com/css2?family=EB+Garamond:ital,wght@0,400;0,500;0,600;0,700;1,400;1,500;1,600;1,700&family=Inconsolata:wght@300;400;500;600;700&family=Outfit:wght@100;200;300;400;500;600;700&display=swap" rel="stylesheet">
+        <link rel="stylesheet" href="/assets/styles.css">
+        <link rel="stylesheet" href="/assets/syntax.css">
+        <link href="https://fonts.googleapis.com/css2?family=EB+Garamond:ital,wght@1,700&family=Inconsolata:wght@300;400;500;600;700&family=Outfit:wght@100;200;300;400;500;600;700&display=swap" rel="stylesheet">
+        <link rel="icon" type="image/x-icon" href="/favicon.ico">
+        <title>{{ site.title }}</title>
+        </head>
+    <body>
+        <div class="container">
+            <div class="main-container">
+                {% include header.html %}
+                    {{ content }}
+                {% include footer.html %}
+            </div>
+        </div>
+    </body>
+</html>

data/_layouts/home.html

@@ -0,0 +1,11 @@
+---
+layout: default
+---
+<div class="profile-container">
+    <h2>{{ site.author.name }}</h2>
+    <img src="/profile.png" alt="">
+    <h3>Welcome to my space on<br>the Internet.</h3>
+</div>
+<div class="posts-container">
+    {% include post-list.html %}
+</div>

data/_layouts/page.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}

data/_layouts/post.html

@@ -0,0 +1,30 @@
+---
+layout: default
+---
+<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
+<article class="post-wrapper">
+  <section class="post-content">
+    <h1>{{ page.title }}</h1>
+    {% if page.date %}
+      <p class="meta" style="color: #696969;"><span style="font-style: italic;">{{ page.date | date_to_string }}</span> | {{ site.author.name }}</p>
+    {% endif %}
+    {{ content }}
+    {% if page.tags.size > 0 %}
+    <div class="post-tags">
+      <p class="meta">
+        {% if page.tags.size > 1 %}
+        TAGS:
+        {% else %}
+        TAG:
+        {% endif %}
+        {% for tag in page.tags %}
+          <a href="/tags.html#{{tag}}" title="tags">{{tag}}</a>
+        {% endfor %}
+      </p>
+    </div>
+    {% endif %}
+  </section>
+  <div class="backwards-link">
+    <p>« <a href="{{ '/' | relative_url }}" class="post-back" title="main-page">Back</a></p>
+  </div>
+</article>

data/_posts/2023-10-12-file-1.md

@@ -0,0 +1,8 @@
+---
+layout: post
+title:  "Example Post 1: Welcome to my space on the Internet!"
+date:   2023-10-12 12:32:50 -0700
+tags: [book, review, ux, design]
+
+---
+Add your content here!

data/_posts/2023-10-13-file-2.md

@@ -0,0 +1,26 @@
+---
+layout: post
+title:  "Example Post 2: The extraordinarily, ordinary life of myself."
+date:   2023-10-13 12:32:50 -0700
+tags: [book, ux]
+
+---
+Add your content here!
+
+# Testing out formats
+This should be _italic_ and this should be **bold**. This should be ***both***!
+
+# Testing out some latex:
+The Pythagorean theorem is $$a^2 + b^2 = c^2$$.
+
+# Testing code snippets:
+
+```java
+
+    public class java {
+        public static void main(String[] args) {
+            System.out.println("Hello World");
+        }
+    }
+
+```

data/_site/2023/10/12/file-1.html

@@ -0,0 +1,86 @@
+<!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <link rel="preconnect" href="https://fonts.googleapis.com">
+        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+        <link href="https://fonts.googleapis.com/css2?family=EB+Garamond:ital,wght@0,400;0,500;0,600;0,700;1,400;1,500;1,600;1,700&family=Inconsolata:wght@300;400;500;600;700&family=Outfit:wght@100;200;300;400;500;600;700&display=swap" rel="stylesheet">
+        <link rel="stylesheet" href="/assets/styles.css">
+        <link rel="stylesheet" href="/assets/syntax.css">
+        <link href="https://fonts.googleapis.com/css2?family=EB+Garamond:ital,wght@1,700&family=Inconsolata:wght@300;400;500;600;700&family=Outfit:wght@100;200;300;400;500;600;700&display=swap" rel="stylesheet">
+        <link rel="icon" type="image/x-icon" href="/favicon.ico">
+        <title>SITE_TITLE</title>
+        </head>
+    <body>
+        <div class="container">
+            <div class="main-container">
+                <!-- <div class="header-container">
+    <nav>
+        <div class="nav-left">
+            <ul>
+                <li><a href="/">SITE_TITLE</a></li>
+            </ul>
+        </div>
+        <div class="nav-right">
+            <ul>
+                <li><a href="/about">About</a></li>
+                <li><a href="/resume.pdf" target="_blank">Resumé</a></li>
+                <li><a href="/contact">Contact</a></li> 
+            </ul>
+        </div>    
+    </nav>
+</div> -->
+
+<div class="header-container">
+    <ul class="nav-left">
+        <li><a href="/">SITE_TITLE</a></li>
+    </ul>
+    <ul class="nav-right">
+        <li><a href="/about" style="padding-left: 20px;">About</a></li>
+        <li><a href="/resume.pdf" target="_blank" style="padding-left: 20px;">Resumé</a></li>
+        <li><a href="/contact" style="padding-left: 20px;">Contact</a></li> 
+    </ul>
+</div>
+                    <script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
+<article class="post-wrapper">
+  <section class="post-content">
+    <h1>Example Post 1: Welcome to my space on the Internet!</h1>
+    
+      <p class="meta" style="color: #696969;"><span style="font-style: italic;">12 Oct 2023</span> | AUTHOR_NAME</p>
+    
+    <p>Add your content here!</p>
+
+    
+    <div class="post-tags">
+      <p class="meta">
+        
+        TAGS:
+        
+        
+          <a href="/tags.html#book" title="tags">book</a>
+        
+          <a href="/tags.html#review" title="tags">review</a>
+        
+          <a href="/tags.html#ux" title="tags">ux</a>
+        
+          <a href="/tags.html#design" title="tags">design</a>
+        
+      </p>
+    </div>
+    
+  </section>
+  <div class="backwards-link">
+    <p>« <a href="/" class="post-back" title="main-page">Back</a></p>
+  </div>
+</article>
+                <footer class="footer">
+    <p class="copyright">
+      &copy; YEAR.
+      Made with ♡ by <a href="mailto:EMAIL@EXAMPLE.COM" class="hard-anchor" title="mailto">AUTHOR_NAME</a> All rights reserved.
+    </p>
+</footer>
+            </div>
+        </div>
+    </body>
+</html>

data/_site/2023/10/13/file-2.html

@@ -0,0 +1,99 @@
+<!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <link rel="preconnect" href="https://fonts.googleapis.com">
+        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+        <link href="https://fonts.googleapis.com/css2?family=EB+Garamond:ital,wght@0,400;0,500;0,600;0,700;1,400;1,500;1,600;1,700&family=Inconsolata:wght@300;400;500;600;700&family=Outfit:wght@100;200;300;400;500;600;700&display=swap" rel="stylesheet">
+        <link rel="stylesheet" href="/assets/styles.css">
+        <link rel="stylesheet" href="/assets/syntax.css">
+        <link href="https://fonts.googleapis.com/css2?family=EB+Garamond:ital,wght@1,700&family=Inconsolata:wght@300;400;500;600;700&family=Outfit:wght@100;200;300;400;500;600;700&display=swap" rel="stylesheet">
+        <link rel="icon" type="image/x-icon" href="/favicon.ico">
+        <title>SITE_TITLE</title>
+        </head>
+    <body>
+        <div class="container">
+            <div class="main-container">
+                <!-- <div class="header-container">
+    <nav>
+        <div class="nav-left">
+            <ul>
+                <li><a href="/">SITE_TITLE</a></li>
+            </ul>
+        </div>
+        <div class="nav-right">
+            <ul>
+                <li><a href="/about">About</a></li>
+                <li><a href="/resume.pdf" target="_blank">Resumé</a></li>
+                <li><a href="/contact">Contact</a></li> 
+            </ul>
+        </div>    
+    </nav>
+</div> -->
+
+<div class="header-container">
+    <ul class="nav-left">
+        <li><a href="/">SITE_TITLE</a></li>
+    </ul>
+    <ul class="nav-right">
+        <li><a href="/about" style="padding-left: 20px;">About</a></li>
+        <li><a href="/resume.pdf" target="_blank" style="padding-left: 20px;">Resumé</a></li>
+        <li><a href="/contact" style="padding-left: 20px;">Contact</a></li> 
+    </ul>
+</div>
+                    <script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
+<article class="post-wrapper">
+  <section class="post-content">
+    <h1>Example Post 2: The extraordinarily, ordinary life of myself.</h1>
+    
+      <p class="meta" style="color: #696969;"><span style="font-style: italic;">13 Oct 2023</span> | AUTHOR_NAME</p>
+    
+    <p>Add your content here!</p>
+
+<h1 id="testing-out-formats">Testing out formats</h1>
+<p>This should be <em>italic</em> and this should be <strong>bold</strong>. This should be <strong><em>both</em></strong>!</p>
+
+<h1 id="testing-out-some-latex">Testing out some latex:</h1>
+<p>The Pythagorean theorem is \(a^2 + b^2 = c^2\).</p>
+
+<h1 id="testing-code-snippets">Testing code snippets:</h1>
+
+<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
+    <span class="kd">public</span> <span class="kd">class</span> <span class="nc">java</span> <span class="o">{</span>
+        <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="nc">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span>
+            <span class="nc">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Hello World"</span><span class="o">);</span>
+        <span class="o">}</span>
+    <span class="o">}</span>
+
+</code></pre></div></div>
+
+    
+    <div class="post-tags">
+      <p class="meta">
+        
+        TAGS:
+        
+        
+          <a href="/tags.html#book" title="tags">book</a>
+        
+          <a href="/tags.html#ux" title="tags">ux</a>
+        
+      </p>
+    </div>
+    
+  </section>
+  <div class="backwards-link">
+    <p>« <a href="/" class="post-back" title="main-page">Back</a></p>
+  </div>
+</article>
+                <footer class="footer">
+    <p class="copyright">
+      &copy; YEAR.
+      Made with ♡ by <a href="mailto:EMAIL@EXAMPLE.COM" class="hard-anchor" title="mailto">AUTHOR_NAME</a> All rights reserved.
+    </p>
+</footer>
+            </div>
+        </div>
+    </body>
+</html>

data/_site/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Revati Tambe
+
+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.

data/_site/README.md

@@ -0,0 +1,62 @@
+# jekyll-dewey-decimal
+
+📖 A content-first, minimal personal weblog and portfolio.
+
+![Screenshot](https://raw.githubusercontent.com/djarty24/jekyll-dewey-decimal/master/screenshot.png)
+
+## Contents
+- [Installation](#installation)
+- [Customizing](#customizing)
+- [Page Layouts](#page-layouts)
+- [Site Settings](#site-settings)
+- [License](#license)
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-dewey-decimal"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-simple-blue
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-dewey-decimal
+
+## Customizing
+
+Using dewey as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings.
+
+To add your own styles copy the [`styles.css`](https://github.com/djarty24/jekyll-dewey-decimal/raw/main/assets/styles.css) into your own project with the same file path (`assets/styles.css`). From there you can add your own styles, and modify or even remove existing ones.
+
+## Page-Layouts
+
+There are 3 layouts; `page`, `post`, and `home` (home acts as the front page blog).
+
+## Site-Settings
+
+To modify set parameters, you need to modify the `_config.yml` `title` and `url`.
+
+Additionally, you need to add the following parameters to edit the author name and email.
+
+```yaml
+author:
+    name: Your name
+    email: Your email
+```
+
+To add your resume, favicon, and a custom profile photo, simply copy them into the root folder with the names `resume.pdf`, `favicon.ico`, and `profile.png`.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).