zepheris/loconotion
1
0
Fork 0
mirror of https://github.com/leoncvlt/loconotion.git synced 2024-08-30 18:12:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Leonardo Cavaletti 2020-05-27 10:14:53 +01:00
parent bc9cce4298
commit 7c0dfbc9b6
2 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,6 +1,6 @@
# Loconotion # 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? ## 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: On top of this, the script can take these optional arguments:
``` ```
-h, --help show this help message and exit
--chromedriver CHROMEDRIVER --chromedriver CHROMEDRIVER
Use a specific chromedriver executable instead of the Use a specific chromedriver executable instead of the
auto-installing one auto-installing one
--single-page Only parse the first page, then stop --single-page Only parse the first page, then stop
--clean Delete all previously cached files for the site before --clean Delete all previously cached files for the site before
generating it 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 --non-headless Run chromedriver in non-headless mode
-v, --verbose Increase output log verbosity -v, --verbose Increase output log verbosity
``` ```
## Roadmap / Features wishlist ## Roadmap / Features wishlist
- [ ] Customizable navbar breadcrumbs
- [ ] Dark / light theme toggle - [ ] Dark / light theme toggle
- [ ] Automated Netlify / GitHub pages / Vercel deployements - [ ] Automated deployements (e.g. Netlify / GitHub pages / Vercel / etc.)
- [ ] Injectable custom HTML - [ ] Injectable custom HTML
- [ ] Html / css / js minification & images optimization - [ ] HTML / CSS / JS minification & images optimization
- [ ] Custom theming - [ ] More advanced custom theming
## Sites built with Loconotion ## 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! 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 [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.
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.

2
pyproject.toml
View File

@ -1,7 +1,7 @@
[tool.poetry] [tool.poetry]
name = "loconotion" name = "loconotion"
version = "0.1.0" version = "0.1.0"
description = "Generate static websites from Notion.so pages" description = "Turn Notion pages into lightweight, customizable static websites"
authors = ["Leonardo Cavaletti <impeto.blu@gmail.com>"] authors = ["Leonardo Cavaletti <impeto.blu@gmail.com>"]
[tool.poetry.dependencies] [tool.poetry.dependencies]