From 18d06ba83143649aa2428ab3aa5e78c0a22f83b2 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Mon, 17 Mar 2025 10:48:34 -0500 Subject: [PATCH] update configuration and README for incorporeal-cms v2 --- .gitignore | 1 + README.md | 21 +++++++++++---------- config.json | 31 +++++++++++++++++++++++++++++++ config.py | 21 --------------------- 4 files changed, 43 insertions(+), 31 deletions(-) create mode 100644 config.json delete mode 100644 config.py diff --git a/.gitignore b/.gitignore index 9b3c3e6..a72150c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ pages/dl/ +venv/ .*.sw* diff --git a/README.md b/README.md index 314664a..2b509ac 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,17 @@ of the project, and submit changes that way. ## Hosting The companion software to this repository is my CMS, [incorporeal-cms](https://git.incorporeal.org/bss/incorporeal-cms). -If you want to run your own version, to see the content how it'd be served, here is the short version of a local setup: +If you want to run your own static site with this content, here is the short version of a local setup: ``` -% mkdir orb.moe -% cd orb.moe -% virtualenv --python=python3.10 env-py3.10 -% source env-py3.10/bin/activate -% pip install -U -f https://bss.zone/tech/incorporeal-cms/ incorporeal-cms[dot] -% mkdir env-py3.10/var -% mkdir env-py3.10/var/incorporealcms-instance -% [copy this repository's files into env-py3.10/var/incorporealcms-instance/] -% FLASK_APP=incorporealcms FLASK_ENV=development flask run -h 0.0.0.0 +% cd path/to/ttrpg-site +% ./git-touch-all.sh +% python -m venv venv +% source venv/bin/activate +% pip install -U pip +% pip install -U incorporeal-cms[dot] +% pip install -U pymdown-extensions +% incorporealcms-build . /path/to/output/dir ``` + +You can serve this content with any HTTP file server, such as Nginx or even `http.server.HTTPServer`. diff --git a/config.json b/config.json new file mode 100644 index 0000000..4f4b3d4 --- /dev/null +++ b/config.json @@ -0,0 +1,31 @@ +{ + "DOMAIN_NAME": "orb.moe", + "TITLE_SUFFIX": "The Orb", + "BASE_HOST": "https://orb.moe", + "CONTACT_EMAIL": "bss@orb.moe", + "AUTHOR": { + "name": "Brian S. Stephan", + "email": "bss@orb.moe" + }, + "DEFAULT_PAGE_STYLE": "dungeon", + "PAGE_STYLES": { + "dungeon": "/static/css/dungeon.css", + "dark": "/static/css/dark.css", + "light": "/static/css/light.css", + "plain": "/static/css/plain.css" + }, + "MARKDOWN_EXTENSIONS": [ + "extra", "incorporealcms.mdx.figures", "incorporealcms.mdx.pydot", + "sane_lists", "smarty", "toc", "attr_list", "tables", "pymdownx.tilde" + ], + "MARKDOWN_EXTENSION_CONFIGS": { + "'extra": { + "footnotes": { + "UNIQUE_IDS": true + } + }, + "toc": { + "toc_depth": "2-5" + } + } +} diff --git a/config.py b/config.py deleted file mode 100644 index 651b6f7..0000000 --- a/config.py +++ /dev/null @@ -1,21 +0,0 @@ -"""Configuration for orb.moe.""" -TITLE_SUFFIX = 'The Orb' -CONTACT_EMAIL = 'bss@orb.moe' - -DEFAULT_PAGE_STYLE = 'dungeon' -PAGE_STYLES = { - 'dungeon': '/custom-static/css/dungeon.css', - 'dark': '/static/css/dark.css', - 'light': '/static/css/light.css', - 'plain': '/static/css/plain.css', -} - -MARKDOWN_EXTENSIONS = [ - 'extra', 'incorporealcms.mdx.figures', 'incorporealcms.mdx.pydot', 'sane_lists', 'smarty', 'toc', - 'attr_list', 'tables', 'pymdownx.tilde', -] -MARKDOWN_EXTENSION_CONFIGS = { - 'toc': { - 'toc_depth': '2-5', - }, -}