bss/incorporeal-cms
1
0
Fork 0
Code Issues 5 Pull Requests Releases 49 Wiki Activity
A lightweight static site generator for Markdown-based sites.
243 Commits 1 Branch 49 Tags 1.2 MiB
Python 83.6%
CSS 7.4%
HTML 6.2%
JavaScript 2.8%
7eb485c6ae
Go to file
Brian S. Stephan 7eb485c6ae
rewrite the project as a static site generator 
this removes Flask, reworks a number of library methods accordingly, and
adds generators and build commands to process the instance directory
(largely unchanged, except config.py is now config.json) and spit out
files suitable to be served by a web server such as Nginx.

there are probably some rough edges here, but overall this works.

also note, as this is no longer server software on a network, the
license has changed from AGPLv3 to GPLv3, and the "or any later version"
allowance has been removed

Signed-off-by: Brian S. Stephan <bss@incorporeal.org>
2025-03-16 23:56:37 -05:00
.reuse rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
incorporealcms rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
LICENSES rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
requirements rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
tests rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
.gitattributes add setup.py with versioneer support 2020-03-07 00:29:17 -06:00
.gitignore convert tooling to pyproject.toml based 2023-12-30 10:33:28 -06:00
CONTRIBUTING.md rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
LICENSE.md rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
MAINTAINERS.md update reference to the DCO now that it's in CONTRIBUTING.md 2024-05-02 09:25:40 -05:00
MANIFEST.in versioneer.py doesn't need to be included in the package 2020-06-18 23:29:37 -05:00
pyproject.toml rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
README.md rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00
tox.ini rewrite the project as a static site generator 2025-03-16 23:56:37 -05:00

README.md

incorporeal-cms

A lightweight static site generator software for Markdown-based sites.

Installation and Usage

I recommend getting a release from https://git.incorporeal.org/bss/incorporeal-cms/releases and installing the Python package in a virtualenv. Something like the following should suffice:

% virtualenv --python=python3.9 env-py3.9
% source env-py3.8/bin/activate
% pip install -U pip
% pip install incorporeal-cms
% incorporealcms-build ./path/to/instance ./path/to/output/www/root

This will generate the directory suitable for serving by e.g. Nginx.

Generating a Site

Put content, notably Markdown content, inside ./your-instance/pages/ and go.

  • Markdown files (ending in .md) are rendered via Python-Markdown as .html files, other files generally left alone and copied to the static site.
  • Directory paths (e.g. /dir/) can be served via a /dir/index.md file.
  • Symlinks to files are retained and handled per the web server's configuration.
  • Non-Markdown files are copied directly, so images, etc., can be referenced naturally.

The application is further configured within ./your-instance/config.json, and content is served

Configuration

I've tried to keep the software agnostic to my personal domains, logos, etc. There are some settings you are probably interested in tweaking, by specifying new values in incorporealcms-instance/config.json:

  • TITLE_SUFFIX is appended to the title of every page, separated from other title content by a dash.
  • CONTACT_EMAIL is referred to in error templates.
  • FAVICON supplies the image used in browser tabs and that kind of thing.

If I missed anything, please let me know.

Development and Contributing

Improvements, new plugins, and etc. are all welcome.

I'm reachable on the fediverse, over email, or on Discord, but if you're looking for an option I prefer, I maintain an IRC channel, #incorporeal-cms, on my IRC network, Randomus if you would like a place to hang out and discuss issues and features and whatnot.

Author and Licensing

Written by and copyright (C) 2025 Brian S. Stephan bss@incorporeal.org.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.