From 7c0dfbc9b6357b5420c048ac3a8272d9dc3b45b0 Mon Sep 17 00:00:00 2001 From: Leonardo Cavaletti Date: Wed, 27 May 2020 10:14:53 +0100 Subject: [PATCH] Updated README.md --- README.md | 19 ++++++++++++------- pyproject.toml | 2 +- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5c0c190..e8de297 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Loconotion -**Loconotion** is a Python script that parses a [Notion.so](https://notion.so) public page (alongside with all of its subpages) and generates a static site out of it. +**Loconotion** is a Python script that parses a [Notion.so](https://notion.so) public page (alongside with all of its subpages) and generates a lightweight, customizable static site out of it. ## But Why? @@ -180,23 +180,29 @@ page = "https://www.notion.so/Loconotion-Example-Page-03c403f4fdc94cc1b315b9469a On top of this, the script can take these optional arguments: ``` + -h, --help show this help message and exit --chromedriver CHROMEDRIVER Use a specific chromedriver executable instead of the auto-installing one --single-page Only parse the first page, then stop --clean Delete all previously cached files for the site before generating it + --clean-css Delete previously cached .css files for the site + before generating it + --clean-js Delete previously cached .js files for the site before + generating it --non-headless Run chromedriver in non-headless mode -v, --verbose Increase output log verbosity ``` ## Roadmap / Features wishlist +- [ ] Customizable navbar breadcrumbs - [ ] Dark / light theme toggle -- [ ] Automated Netlify / GitHub pages / Vercel deployements +- [ ] Automated deployements (e.g. Netlify / GitHub pages / Vercel / etc.) - [ ] Injectable custom HTML -- [ ] Html / css / js minification & images optimization -- [ ] Custom theming +- [ ] HTML / CSS / JS minification & images optimization +- [ ] More advanced custom theming ## Sites built with Loconotion @@ -204,7 +210,6 @@ On top of this, the script can take these optional arguments: If you used Loconotion to build a cool site and want it added to the list above, shoot me a mail or submit a pull request! -## Support +## Support ![https://www.buymeacoffee.com/leoncvlt](https://img.shields.io/badge/-buy%20me%20a%20coffee-lightgrey?style=flat&logo=buy-me-a-coffee&color=FF813F&logoColor=white) -![](https://img.shields.io/badge/-buy%20me%20a%20coffee-lightgrey?style=flat&logo=buy-me-a-coffee&color=FF813F&logoColor=white) -If you found this useful, consider sponsoring a coffee so I get a a nice dose of methilxanthine, and you get a nice dose of karma. +If you found this useful, consider [buying me a coffee](https://www.buymeacoffee.com/leoncvlt) so I get a a nice dose of methilxanthine, and you get a nice dose of karma. diff --git a/pyproject.toml b/pyproject.toml index c15fd1a..5ceb8f9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] name = "loconotion" version = "0.1.0" -description = "Generate static websites from Notion.so pages" +description = "Turn Notion pages into lightweight, customizable static websites" authors = ["Leonardo Cavaletti "] [tool.poetry.dependencies]