diff --git a/README.md b/README.md index 674b16a..549d0e8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ +![picopaper logo](images/logo.png) + # picopaper A minimal static site generator for blogs built with Python 3 and Jinja2 - Status: alpha - expect many changes +- [Issue Tracker](https://git.uphillsecurity.com/cf7/picopaper/issues) - Goals: keeping it simple and easy to understand -- Demo: +- Demo: [picopaper.com](https://picopaper.com/) Show cases: +- [securitypending.com](https://securitypending.com/) --- @@ -21,6 +25,8 @@ Show cases: - Static files - separate feeds (used for categories, tagging, etc) `/feed/{tag}` - exclusion of feeds from main feed (drafts or system notes) +- HTML anchors for headers +- list random posts at the bottom **Ideas**: - RSS @@ -155,6 +161,12 @@ To switch themes, change the `THEME` setting in `config.py` --- +## Notes + +- [Github Mirror](https://github.com/CaffeineFueled1/picopaper) + +--- + ## Security For security concerns or reports, please contact via `hello a t uphillsecurity d o t com` [gpg](https://uphillsecurity.com/gpg). diff --git a/config.py b/config.py index b7976d8..2f193d3 100644 --- a/config.py +++ b/config.py @@ -1,6 +1,6 @@ """Configuration file for picopaper blog""" -BLOG_TITLE = "picopaper" +BLOG_TITLE = "PicoPaper.com" BLOG_DESCRIPTION = "we like simple." THEME = "default" @@ -10,6 +10,12 @@ EXCLUDE_FEEDS_FROM_MAIN = ['draft','private'] # e.g., ['python', 'drafts'] # Navigation bar items - list of dictionaries with 'text' and 'url' keys NAVBAR_ITEMS = [ {'text': 'Home', 'url': '/'}, + {'text': 'Feeds', 'url': '/feed/'}, {'text': 'About', 'url': '/about/'} ] +# Logo settings +HIDE_LOGO = False +HIDE_TITLE = True +LOGO_PATH = "/images/logo.png" + diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 0000000..5f00575 Binary files /dev/null and b/images/logo.png differ diff --git a/items/2025-10-06_long_your-first-article_tutorial.md b/items/2025-10-06_long_your-first-article_tutorial.md index 7a08a85..0187ff1 100644 --- a/items/2025-10-06_long_your-first-article_tutorial.md +++ b/items/2025-10-06_long_your-first-article_tutorial.md @@ -3,3 +3,15 @@ This is a `long` form articles. In the main feed, it is a simple link to the rest of the content. Please check the [official documentation](https://git.uphillsecurity.com/cf7/picopaper) for more details. + +## Second Header + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Massa porta accumsan eros aliquet consequat elit tincidunt imperdiet in adipiscing diam integer risus. Dapibus bibendum adipiscing rhoncus parturient fusce ultrices in accumsan phasellus tempus est senectus felis. Donec placerat porta lobortis magna consectetur hac pretium eleifend tempor cum nulla fusce aliquet. + +Primis amet nullam dictum ridiculus neque ipsum elit volutpat mauris posuere pellentesque euismod felis. Cum nunc ullamcorper dictum metus maecenas accumsan elit purus convallis vulputate mauris sollicitudin diam. Diam iaculis aliquet eleifend sociosqu nostra massa malesuada feugiat sit penatibus dolor montes purus. Porta vulputate dictumst sodales dolor ad euismod consequat interdum mus porttitor erat torquent consequat. + +## Third Header + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Massa porta accumsan eros aliquet consequat elit tincidunt imperdiet in adipiscing diam integer risus. Dapibus bibendum adipiscing rhoncus parturient fusce ultrices in accumsan phasellus tempus est senectus felis. Donec placerat porta lobortis magna consectetur hac pretium eleifend tempor cum nulla fusce aliquet. + +Primis amet nullam dictum ridiculus neque ipsum elit volutpat mauris posuere pellentesque euismod felis. Cum nunc ullamcorper dictum metus maecenas accumsan elit purus convallis vulputate mauris sollicitudin diam. Diam iaculis aliquet eleifend sociosqu nostra massa malesuada feugiat sit penatibus dolor montes purus. Porta vulputate dictumst sodales dolor ad euismod consequat interdum mus porttitor erat torquent consequat. diff --git a/items/2025-10-09_short_features.md b/items/2025-10-09_short_features.md new file mode 100644 index 0000000..78dffec --- /dev/null +++ b/items/2025-10-09_short_features.md @@ -0,0 +1,13 @@ +# Features + +- Simple - easy to understand and modify +- Posts for short and long-form content + pages like [/about/](/about/) +- theming +- separate feeds like [/feed/tutorial/](/feed/tutorial/) +- excluding feeds in config file like [/feed/draft/](/feed/draft/) +- static files like [/LICENSE](/LICENSE) +- html anchors for headers like [#second-header](/your-first-article/#second-header) +- show random posts at the end of the page + +Everything is **[open-source](https://git.uphillsecurity.com/cf7/picopaper)**! + diff --git a/picopaper.py b/picopaper.py index b7d5407..700bc67 100644 --- a/picopaper.py +++ b/picopaper.py @@ -6,7 +6,7 @@ from datetime import datetime from pathlib import Path from jinja2 import Environment, FileSystemLoader import markdown -from config import BLOG_TITLE, BLOG_DESCRIPTION, THEME, EXCLUDE_FEEDS_FROM_MAIN, NAVBAR_ITEMS +from config import BLOG_TITLE, BLOG_DESCRIPTION, THEME, EXCLUDE_FEEDS_FROM_MAIN, NAVBAR_ITEMS, HIDE_LOGO, HIDE_TITLE, LOGO_PATH class SSGGGenerator: def __init__(self, items_dir='items', output_dir='output', theme=None, blog_title=None, blog_description=None): @@ -20,12 +20,23 @@ class SSGGGenerator: self.blog_description = blog_description or BLOG_DESCRIPTION self.exclude_feeds = EXCLUDE_FEEDS_FROM_MAIN self.navbar_items = NAVBAR_ITEMS + self.hide_logo = HIDE_LOGO + self.hide_title = HIDE_TITLE + self.logo_path = LOGO_PATH # Setup Jinja2 self.env = Environment(loader=FileSystemLoader(self.templates_dir)) - # Setup markdown - self.md = markdown.Markdown(extensions=['extra']) + # Add custom filter for random sampling + def random_sample(items, count): + import random + items_list = list(items) + return random.sample(items_list, min(count, len(items_list))) + + self.env.filters['random_sample'] = random_sample + + # Setup markdown with toc extension for header anchors + self.md = markdown.Markdown(extensions=['extra', 'toc']) def parse_filename(self, filename): """Parse filename format: YYYY-MM-DD_type_name[_feed].md""" @@ -47,6 +58,20 @@ class SSGGGenerator: 'filename': filename } + def add_header_anchors(self, html_content): + """Add anchor links to headers with IDs""" + # Pattern to match headers with id attributes:

Text

+ def replace_header(match): + tag = match.group(1) + header_id = match.group(2) + text = match.group(3) + # Add anchor link with # symbol + return f'<{tag} id="{header_id}">{text} #' + + # Match h2-h6 tags with id attributes + pattern = r'<(h[2-6]) id="([^"]+)">([^<]+)<\/\1>' + return re.sub(pattern, replace_header, html_content) + def read_post(self, filepath): """Read markdown file and extract title and content""" with open(filepath, 'r', encoding='utf-8') as f: @@ -63,6 +88,9 @@ class SSGGGenerator: # Convert markdown to HTML html_content = self.md.convert(content) + # Add anchor links to headers + html_content = self.add_header_anchors(html_content) + return title, html_content def collect_posts(self): @@ -89,7 +117,7 @@ class SSGGGenerator: 'title': title, 'content': content, 'slug': parsed['name'], - 'url': f"{parsed['name']}/", + 'url': f"/{parsed['name']}/", 'feed': parsed['feed'], 'source': filepath.name } @@ -101,7 +129,7 @@ class SSGGGenerator: return posts - def generate_index(self, posts, feed_name=None): + def generate_index(self, posts, feed_name=None, all_posts=None): """Generate index.html with all posts (or feed-specific index)""" template = self.env.get_template('index.tmpl') @@ -117,7 +145,11 @@ class SSGGGenerator: blog_title=self.blog_title, blog_description=self.blog_description, navbar_items=self.navbar_items, - posts=posts + posts=posts, + all_posts=all_posts or posts, + hide_logo=self.hide_logo, + hide_title=self.hide_title, + logo_path=self.logo_path ) output_path.parent.mkdir(parents=True, exist_ok=True) @@ -126,7 +158,41 @@ class SSGGGenerator: print(f"✓ Generated {output_path}") - def generate_post_page(self, post): + def generate_feeds_overview(self, feeds, all_posts=None): + """Generate /feed/index.html with list of all non-excluded feeds""" + template = self.env.get_template('feeds.tmpl') + + # Prepare feed data with counts, excluding feeds in EXCLUDE_FEEDS_FROM_MAIN + feed_list = [] + for feed_name, posts in sorted(feeds.items()): + if feed_name not in self.exclude_feeds: + feed_list.append({ + 'name': feed_name, + 'count': len(posts) + }) + + title = f"Feeds - {self.blog_title}" + output_path = self.output_dir / 'feed' / 'index.html' + + html = template.render( + title=title, + blog_title=self.blog_title, + blog_description=self.blog_description, + navbar_items=self.navbar_items, + feeds=feed_list, + all_posts=all_posts or [], + hide_logo=self.hide_logo, + hide_title=self.hide_title, + logo_path=self.logo_path + ) + + output_path.parent.mkdir(parents=True, exist_ok=True) + with open(output_path, 'w', encoding='utf-8') as f: + f.write(html) + + print(f"✓ Generated {output_path}") + + def generate_post_page(self, post, all_posts=None): """Generate individual post page for 'long' posts""" template = self.env.get_template('post.tmpl') @@ -135,7 +201,11 @@ class SSGGGenerator: blog_title=self.blog_title, blog_description=self.blog_description, navbar_items=self.navbar_items, - post=post + post=post, + all_posts=all_posts or [], + hide_logo=self.hide_logo, + hide_title=self.hide_title, + logo_path=self.logo_path ) # Create directory for the post slug @@ -199,7 +269,7 @@ class SSGGGenerator: and p['feed'] not in self.exclude_feeds] # Generate main index with filtered feed posts - self.generate_index(feed_posts) + self.generate_index(feed_posts, all_posts=feed_posts) # Group posts by feed (include all posts, not just those in main feed) feeds = {} @@ -209,12 +279,16 @@ class SSGGGenerator: # Generate feed-specific pages for feed_name, posts in feeds.items(): - self.generate_index(posts, feed_name) + self.generate_index(posts, feed_name, all_posts=feed_posts) - # Generate individual pages for long posts and pages + # Generate feeds overview page + if feeds: + self.generate_feeds_overview(feeds, all_posts=feed_posts) + + # Generate individual pages for long posts, short posts, and pages for post in all_posts: - if post['type'] in ['long', 'page']: - self.generate_post_page(post) + if post['type'] in ['long', 'short', 'page']: + self.generate_post_page(post, all_posts=feed_posts) # Copy assets self.copy_assets() diff --git a/static/LICENSE b/static/LICENSE new file mode 100644 index 0000000..2b146bc --- /dev/null +++ b/static/LICENSE @@ -0,0 +1,202 @@ +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. + diff --git a/static/pubkey.asc b/static/pubkey.asc deleted file mode 100644 index 279d5f8..0000000 --- a/static/pubkey.asc +++ /dev/null @@ -1,6 +0,0 @@ ------BEGIN PGP PUBLIC KEY BLOCK----- - -Example GPG public key file -This file will be copied as-is to the output directory - ------END PGP PUBLIC KEY BLOCK----- diff --git a/theme/default/assets/style.css b/theme/default/assets/style.css index fb77f82..9b276fc 100644 --- a/theme/default/assets/style.css +++ b/theme/default/assets/style.css @@ -12,9 +12,24 @@ header { padding: 20px; margin-bottom: 40px; border-radius: 10px; + text-align: center; } -h1 { margin: 0; } +img { + max-width: 100%; +} + +hr { + border: 1px solid #efefef; +} + +h1 { + margin: 0; +} + +.header-logo { + vertical-align: middle; +} .blog-description { margin: 10px 0 0 0; @@ -26,7 +41,9 @@ h1 { margin: 0; } margin-top: 15px; font-weight: bold; display: flex; + justify-content: center; gap: 10px; + flex-wrap: wrap; } .nav-item { diff --git a/theme/default/templates/feeds.tmpl b/theme/default/templates/feeds.tmpl new file mode 100644 index 0000000..c03aae7 --- /dev/null +++ b/theme/default/templates/feeds.tmpl @@ -0,0 +1,20 @@ + + + + {% include 'meta.tmpl' %} + + + {% include 'header.tmpl' %} + +
+

Feeds

+ +
+ + {% include 'footer.tmpl' %} + + diff --git a/theme/default/templates/header.tmpl b/theme/default/templates/header.tmpl index 22b854c..e92c6f6 100644 --- a/theme/default/templates/header.tmpl +++ b/theme/default/templates/header.tmpl @@ -1,5 +1,14 @@
-

{{ blog_title }}

+

+ + {% if not hide_logo %} + + {% endif %} + {% if not hide_title %} + {{ blog_title }} + {% endif %} + +

{{ blog_description }}