webgen/README.md

1.3 KiB

Webgen

hi this is a very simple program for merging a text file into a webpage

it was only made for my website that is not in use at the moment

documentation may be incomplete

how to use it yourself

  • first edit mix.exs line 16 to use your desired path (i didn't find any better way to solve this)
  • then create a file called "gen-conf" in that directory (use the example-gen-conf file included as an example). the first line is the "base website" that is going to be used. on following lines, write the relative path to files you want to merge into webpages
  • now you can, in the same directory, create files with the website content
  • two newlines convert to a paragraph break, one newline converts to <br>
  • when running the program (open a shell, cd to here and enter mix run) it should save the files as $file.html

help what are the $ things?

  • $title - the title, which is the first line of content files
  • $first - the first line of the page, with html tags stripped away
  • $file - the relative path without index/ as the first characters
  • $content - the page body without the title refer to example-gen-conf for an example

if something here does not make sense, you can ask me for help, preferably on matrix at @e:lu.gl or at https://transmom.love/@ella