Cybrkyd's git repositories

unused-css • commit: e6751f7

commit e6751f7c71eb670304d3266219eb952a94a63c5c465a09ea7f0368242dcf0eff
author cybrkyd <noreply@cybrkyd.com> 2025-08-02 21:22:58 +0100
committer cybrkyd <noreply@cybrkyd.com> 2025-08-02 21:22:58 +0100

Commit Message

README is now Markdown

📊 Diffstat

README 39
README.md 36
2 files changed, 36 insertions(+), 39 deletions(-)

Diff

diff --git a/README b/README
deleted file mode 100644
index 936b745..0000000
--- a/README
+++ /dev/null
@@ -1,43 +0,0 @@
- ==================================
- Find unused CSS with Python
- ==================================
-
- A Python script to find unused CSS classes.
-
-
- Requirements
-------------
-
- * Python 3.5+
-
- pip install cssutils
-
-
- Running
--------
-
- In def main(), edit the paths:
-
- html_directory = '/path/to/html/dir'
- css_files = [
- '/path/to/css/styles.css',
- '/path/to/css/bootstrap.css'
- ]
-
- Then execute the script. The report with name
- `unused_css_report_{timestamp}.txt` is output in the same folder where the
- Python script is run from.
-
-
- See also
---------
-
- The blog post: https://cybrkyd.com/post/find-unused-css-with-python/
-
-
- Licence
--------
-
- This project is made available under a GPL3 licence -- see COPYING
- for the full text.
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bbce2f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+ # Find unused CSS with Python
+
+ A Python script to find unused CSS classes.
+
+ ## Requirements
+
+ * Python 3.5+
+ * cssutils
+
+ Install it with:
+ ```
+ pip install cssutils
+ ```
+
+ ## Running
+
+ In `def main()`, edit the paths:
+
+ ```
+ html_directory = '/path/to/html/dir'
+ css_files = [
+ '/path/to/css/styles.css',
+ '/path/to/css/bootstrap.css'
+ ]
+ ```
+
+ Then execute the script. The report with name `unused_css_report_{timestamp}.txt` is output in the same folder where the Python script is run from.
+
+ ## See also
+
+ The blog post: <a href="https://cybrkyd.com/post/find-unused-css-with-python" target="&#95;blank" rel="noopener">Find unused CSS with Python</a>
+
+ ## Licence
+
+ This project is made available under a GPL3 licence -- see COPYING for the full text.
+