bss/ttrpg-site
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update configuration and README for incorporeal-cms v2

Browse Source
This commit is contained in:
Brian S. Stephan 2025-03-17 10:48:34 -05:00
parent 5d2ae359fd
commit 18d06ba831
Signed by: bss
GPG Key ID: 3DE06D3180895FCB
4 changed files with 43 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1,3 +1,4 @@
pages/dl/
venv/
.*.sw*

21
README.md
View File

@ -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`.

31
config.json Normal file
View File

@ -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"
}
}
}

21
config.py
View File

@ -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',
},
}