do some trivial cleanups in README
Signed-off-by: Brian S. Stephan <bss@incorporeal.org>
This commit is contained in:
parent
d49b9d48a8
commit
359916e7d9
@ -14,19 +14,19 @@ Something like the following should suffice:
|
||||
% 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
|
||||
|
||||
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:
|
||||
|
||||
* 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 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.
|
||||
* 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.
|
||||
|
||||
## Configuration
|
||||
|
Loading…
Reference in New Issue
Block a user