silkie
cmd-ssg
Our great sponsors
silkie | cmd-ssg | |
---|---|---|
12 | 4 | |
2 | 1 | |
- | - | |
0.0 | 3.5 | |
over 2 years ago | 10 months ago | |
Python | JavaScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
silkie
-
How I Set Up GitHub Actions for a Python Project
Last week, I already set up some automation tests for Silkie, my static site generator (SSG). Instead of running tests manually on each Pull Request (PR), I made an attempt to configure GitHub Actions to automate this Continuous Integration (CI) workflow. Moreover, I also helped my friend, Luke, add a test case to his SSG this week.
-
Lab9 Continuous Integration Pipelines and Test Automation
According to my parter's issue, I create a new test file named. I pull a new PR, the partner's Actions passed it. Before that, I found that many projects have the function of automatic error checking. I wonder how to do it. After lab9, I also created my own GitHub actions. I'm very excited.
-
How I Set Up Testing for My Python Project
After setting up static analysis tools last week, it's time to configure a testing framework for Continuous Integration (CI). There are several options for Silkie, my work-in-progress static site generator, but I decided to give Pytest a try. In this blog, I'll show you how I set up:
-
2 Static Analysis Tools to Enhance Your Productivity
If you are tired of maintaining your coding style, I have good news for you. Fortunately, there are developer tools that can automate and streamline mundane development tasks. In this blog, I'll show you how I integrated 2 static code analysis tools and a package manager for pre-commit hooks into Silke, my work-in-progress static site generator.
-
Prototype: Markdown Frontmatter Support for Silkie
After wandering the world of static site generators (SSG), I came across an eye-catching, well-documented, and developer-friendly one focusing on documentation sites: Docusaurus. After diving a bit deeper into their documentation, I realized they have many out-of-the-box features, which I can try integrating into Silke, an SSG I wrote from scratch.
-
How I Refactored my Code
This week, I noticed that some functions in my static site generator (SSG) were hardcoded with complex logic and "magic values", so I decided to focus on refactoring them. Without cleaning them up, maintaining them would be a tragedy. For instance, there was a function spanning 36 lines of code with 8 if/elif statements. Some of the statements even have nested if/elif statements themselves. You can find the function referenced in this issue.
-
Working with Remote Branches
This week on my Open Source journey, I attempted to add support for JSON formatted configuration files for an open source Static Site Generator (SSG). The owner of the repo, Tengzhen, also contributed the same feature to my SSG, Silkie. However, I made a step forward by testing his code from a tracking branch before merging it.
-
3 Things I Learned From Contributing to Open Source
As for Eugene, he also contributed the same feature to Silkie, my SSG. I noticed his code might need to be fixed and refactored, so we worked together on both Slack and GitHub to resolve those issues. Given our time constraint and Eugene's lack of experience with Python, it was a success that we managed to add a new feature without breaking the existing ones.
-
My First Baby Steps in Open Source
Not long after he started, the first issue was found. As expected, all I could say was:
cmd-ssg
-
3 Things I Learned From Contributing to Open Source
This week, I've been contributing to another static site generator (SSG). I've picked up a few things that may be useful to first time open source contributors:
-
Lab 1 reviewing other student code sources
Testing and reviewing code might sound difficult, but with my previous co-op experience. I got better and better to read someone else code. It is like reviewing a Pull request. No code is perfect, they will be always a bug, improper formatting, unnecessary comment. One of the issue reading his code was the code wasn't properly formatted and they are random comment all over the place. Issue #2, Issue #3. After creating those issue Eugene fixed within a day and the code was much nicer to read.
What are some alternatives?
Hyde - A Python Static Website Generator
Flake8 - flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.
Magic-SSG
text-ssg - Release 0.1.0
tg-archive - A tool for exporting Telegram group chats into static websites like mailing list archives.
ssg-factory
black - The uncompromising Python code formatter
htmd - Write Markdown and Jinja2 templates to create a website
Docusaurus - Easy to maintain open source documentation websites.
pytest-watch - Local continuous test runner with pytest and watchdog.
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.
Python-Markdown - A Python implementation of John Gruber’s Markdown with Extension support.