about summary refs log tree commit diff
path: root/readme.md
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2024-02-24 02:24:50 -0600
committergennyble <gen@nyble.dev>2024-02-24 02:24:50 -0600
commitd716ffb05f086061d9a5302f67f3695457fcff02 (patch)
tree1232bbdf657e50d78a960b57ce0db6f288384ca2 /readme.md
parent9976c697f4a562da22aad36786878073c8acd4bb (diff)
downloadawake-d716ffb05f086061d9a5302f67f3695457fcff02.tar.gz
awake-d716ffb05f086061d9a5302f67f3695457fcff02.zip
Implement basic markup system
this also has the redirection from non-trailing-slash-directories to their slashy counterparts
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index b7a3651..e870276 100644
--- a/readme.md
+++ b/readme.md
@@ -20,6 +20,11 @@ What do you name the root file, then? You shouldn't have to match the webroot's
 directory name. Perhaps it should be configurable. I think for now we'll
 hard-code in `home.html`, though.
 
+**TODO:**  
+we need to redirect directories to themselves with slashes. The browser thinks
+that anything not ending in a slash is a file. It couldvery well be right, but
+this causes chaos when we try to relative link to a directories resources.
+
 ## Page-content uses templates
 Because writing the same outer-html for everything poses a few problems. I'll
 enumerate them for fun!
@@ -64,4 +69,27 @@ a one or two sentence description of the page.
 
 <!-- not required but helps make better cards, etc. -->
 <meta property="og:description" content="gone for now. stepped out for a bit." />
-```
\ No newline at end of file
+```
+
+## Page content uses a weird kind of markup language
+It's mostly just HTML, but I'm tired of writing `<p>` so damn much.
+
+A block of text, a textblock, are consecutive lines that contain text. A double
+linebreak separates blocks. If a block starts with a `<` it's assumed to be raw
+HTML and will not be wrapped in a paragraph. 
+
+You can escape any commands or annotations, both of which are described below,
+with a `\`. Like this: `\[`. You can also escape the slash itself, `\\`, or an
+opening greater-than, `\<`.
+
+### commands
+
+**[@paragraphs off]** - stop wrapping text-blocks in paragrapha and just pass
+them through as is. this is useful for HTML.
+
+**[@paragraphs on]** - start wrapping text-blocks in paragraphs starting at
+the next line.
+
+### annotations
+
+**[#element-id]** - give the paragraph for this text block an ID of `element-id`
\ No newline at end of file