This repository has been archived on 2022-09-03. You can view files and clone it, but cannot push or open issues or pull requests.
ssg-lua/outline.txt
2022-09-03 23:02:20 -04:00

42 lines
1.4 KiB
Plaintext

Overview:
md-lint.lua converts all files in the markdown/ directory into a
subset of md capable of being translated into comparable gemtext
and HTML. The output is fed into gemtext-gen.lua and html-gen.lua
to generate format specific documents.
html-gen.lua will take pieces of other md-to-HTML converters from
github to save development time.
gemtext-gen.lua will likely need to be developed mostly from scratch.
the whole process of generating a site will be done with a main program
that orchestrates the process of converting the files in the markdown/
directory into the correct HTML and gemtext files in the HTML/ and
gemini/ directories.
the src/ directory will contain the lua programs and the folders for
the HTML and gemini specific configs. These would include format
specific headers and footers that would be manually written and
added to all generated documents of that type. For example in your
src/html-config/header.html you may want to include a link to a
CSS style sheet. And a CSS style sheet would also be kept in the
html-config/ directory
any content that cant be represented as text can be linked to on the
generated site. Files like images and pdfs are stored in the files/
directory and sorted by file extension into folders.
organized into these directories
ssg-lua/
src/
html-config/
gemini-config/
markdown/
html/
gemini/
files/
images/
pdfs/
archives/