bss/incorporeal-cms
1
0
Fork 0
Code Issues 5 Pull Requests Releases 49 Wiki Activity

do some trivial cleanups in README

Browse Source 
Signed-off-by: Brian S. Stephan <bss@incorporeal.org>
This commit is contained in:
Brian S. Stephan 2025-03-18 21:18:41 -05:00
parent d49b9d48a8
commit 359916e7d9
Signed by: bss
GPG Key ID: 3DE06D3180895FCB
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -14,19 +14,19 @@ Something like the following should suffice:
% incorporealcms-build ./path/to/instance ./path/to/output/www/root % incorporealcms-build ./path/to/instance ./path/to/output/www/root
``` ```
This will generate the directory suitable for serving by e.g. Nginx. This will generate the directory suitable for serving by e.g. nginx.
## Creating a Site ## Creating a Site
Put content, notably Markdown content, inside `./your-instance/pages/` and when you are ready, run the build command Put content, notably Markdown content, inside `./your-instance/pages/` and when you are ready, run the build command
above. When you run `incorporealcms-build`, the following happens: above. When you run `incorporealcms-build`, the following happens:
* Markdown files (ending in `.md`) are rendered via Python-Markdown as .html files and output to the static site * Markdown files (ending in `.md`) are rendered via Python-Markdown as `.html` files and output to the static site
directory. The `.md` files are also copied there, though this behavior may be toggleable in the future. directory. The `.md` files are also copied there, though this behavior may be toggleable in the future.
* Directory paths (e.g. a request to `/dir/`) can be served via a `/dir/index.md` file, which will generate * Directory paths (e.g. a request to `/dir/`) can be served via a `/dir/index.md` file, which will generate
`/dir/index.html`, with the appropriate web server configuration to use `index.html` for directory listings. `/dir/index.html`, with the appropriate web server configuration to use `index.html` for directory listings.
* Symlinks to files are retained and mirrored into the output directory, and handled per the web server's configuration, * Symlinks to files are retained and mirrored into the output directory, and handled per the web server's configuration,
whanever it is. whatever it is.
* All other files are copied directly, so images, text files, etc., can be referenced naturally as URLs. * All other files are copied directly, so images, text files, etc., can be referenced naturally as URLs.
## Configuration ## Configuration

0
tests/instance/custom-static/css/warm.css → tests/instance/pages/static/css/warm.css
View File