chore: add formatShortcode function to styling module

initialize markdownFiles table
check html files
check index.html and index.md

README.md

@@ -1,2 +1,22 @@
 # luago
 Static website generator written in Lua
+> Still in development
+> Please don't use for production yet
+> There are a lot of work to do
+
+## what it does
+- reads .md files in that directory and create html files
+- transforms basic markdown syntax to html styling
+
+### features
+- read all md files
+- check if index.md and index.html files are exists (if not stop with error)
+- read options section on every md file
+- clear public/ directory and create if not exists
+- create html files using same name template html file
+- if there are no html file for that md file, use index.html
+- {{pageContent}}, {{pageTitle}} and {{list:}}-{{:list}} shortcodes
+- list.item.<option> shortcode inside list shortcode
+
+luago name
+: **lua** + **hugo** (can't thing of anything better)

fileStruct.lua

@@ -0,0 +1,45 @@
+local lfs = require("lfs")
+
+return function(currentDir)
+    local markdownFiles = {}
+    local haveIndexmd = false
+    local haveIndexhtml = false
+    local markdownFileCount = 0
+
+    -- initialize markdownFiles table
+    for file in lfs.dir(currentDir) do
+        if not(file:sub(1, 2) == ".." or file:sub(1, 1) == '.') then
+            local filePath = currentDir .. '/' .. file
+            if file == "index.md" then haveIndexmd = true end
+            if file == "index.html" then haveIndexhtml = true end
+            if file:match("%.md$") then
+                markdownFileCount = markdownFileCount + 1
+                markdownFiles[markdownFileCount] = {
+                    options = {},
+                    filePath = filePath,
+                    fileName = file:sub(1, file:len() - 3),
+                    content = "",
+                    hasHtml = false
+                }
+            end
+        end
+    end
+
+    -- check html files
+    for file in lfs.dir(currentDir) do
+        if file:match("%.html$") then
+            for index, value in ipairs(markdownFiles) do
+                if file == value.fileName .. ".html" then
+                    markdownFiles[index].hasHtml = true
+                    print(value.fileName .. " file has a html template file.")
+                end
+            end
+        end
+    end
+
+    if not(haveIndexhtml) or not(haveIndexmd) then
+        return nil, "Can't find index.html or index.md!"
+    end
+
+    return markdownFiles
+end

luago.lua

@@ -1,34 +1,15 @@
+local script_dir = debug.getinfo(1, "S").source:match("@?(.*/)")
+if script_dir then package.path = script_dir .. "?.lua;" .. script_dir .. "?/init.lua;" .. package.path end
+
 local lfs = require("lfs")
-
--- list of markdown files in working directory
-local markdownFiles = {}
-
-local haveIndexmd = false
-local haveIndexhtml = false
--- amount of markdown files in working directory
-local markdownFileCount = 0
 local currentDir = lfs.currentdir()
-for file in lfs.dir(currentDir) do
-    -- ignore "." and ".." files
-    if not(file:sub(1,2) == ".." or file:sub(1,1) == '.') then
-        local filePath = currentDir .. '/' .. file
-        -- match file names ending with ".md"
-        if file:match("index.md") then haveIndexmd = true end
-        if file:match("index.html") then haveIndexhtml = true end
-        if file:match("%.md$") then
-            markdownFileCount = markdownFileCount + 1
-            markdownFiles[markdownFileCount] = {
-                options = {},
-                filePath = filePath,
-                fileName = file:sub(1, file:len()-3),
-                content = ""
-            }
-        end
-    end
-end
 
--- stop the program if "index.html" or "index.md" doesn't exist
-if (not(haveIndexhtml) and not(haveIndexmd)) then return print("Can't find index.html or index.md!") end
+-- initialize markdownFiles table and check html files
+local markdownFiles, err = require("fileStruct")(currentDir)
+-- print error and stop the program if index.html or index.md doesn't exist
+if not markdownFiles then
+    return print(err)
+end
 
 -- check for options section on every markdown file
 for index, file in ipairs(markdownFiles) do
@@ -51,7 +32,7 @@ for index, file in ipairs(markdownFiles) do
             end
 
             -- fill options table
-            for i, value in ipairs(lines) do
+            for _, value in ipairs(lines) do
                 if value:sub(value:len(), value:len()) == "\n" then
                     value = value:sub(1, value:find("\n")-1)
                 end
@@ -73,7 +54,7 @@ for index, file in ipairs(markdownFiles) do
 end
 
 -- replace markdownFiles.content with md file content
-for index, value in ipairs(markdownFiles) do
+for index, _ in ipairs(markdownFiles) do
     local f = io.open(markdownFiles[index].filePath)
     if f then
         local content = f:read("*a")
@@ -87,7 +68,7 @@ for index, value in ipairs(markdownFiles) do
     end
 end
 
-for index, value in ipairs(markdownFiles) do
+for index, _ in ipairs(markdownFiles) do
     print("---------------")
     -- print file path with index
     print(index .. ': ' .. markdownFiles[index].filePath)
@@ -109,39 +90,57 @@ end
 
 -- get index.html content
 local indexFile = io.open("index.html"):read("*all")
-local siteName
-local siteTitle
 
--- remove and create "public/" directory
-lfs.rmdir("public")
-lfs.mkdir("public")
-
-for index, value in ipairs(markdownFiles) do
-    local workDir = lfs.currentdir()
-    -- create html file for that md file
-    local htmlFile = io.open(workDir .. "/public/" .. markdownFiles[index].fileName .. ".html", 'w')
-    if htmlFile then
-        local content = indexFile
-        -- replace <!-- sitecontents --> with markdown file content
-        local start_idx, end_idx = content:find("<!-- sitecontents -->", 1, true)
-        if start_idx and end_idx then
-            local first = content:sub(1, start_idx - 1)
-            local second = content:sub(end_idx + 1)
-            content = first .. markdownFiles[index].content .. second
-        end
-        while content:find("<!-- title -->", 1, true) do
-            start_idx, end_idx = content:find("<!-- title -->", 1, true)
-            if start_idx and end_idx then
-                local first = content:sub(1, start_idx - 1)
-                local second = content:sub(end_idx + 1)
-                content = first .. markdownFiles[index].options["title"] .. second
-            end
-        end
-
-        htmlFile:write(content)
-        htmlFile:close()
-    else
-        print("Error: Cannot create html file for " .. markdownFiles[index].filePath)
+-- delete html files and create "public/" directory
+for file in lfs.dir(currentDir .. "/public") do
+    if file:match("%.html$") then
+        os.remove(currentDir .. "/public/" .. file)
     end
 end
+lfs.mkdir("public")
 
+for index, _ in ipairs(markdownFiles) do
+    if markdownFiles[index].options["draft"] ~= "yes" then
+        local workDir = lfs.currentdir()
+        -- create html file for that md file
+        local htmlFile = io.open(workDir .. "/public/" .. markdownFiles[index].fileName .. ".html", 'w')
+        if htmlFile then
+            local content = indexFile
+            if markdownFiles[index].hasHtml then content = io.open(markdownFiles[index].fileName .. ".html"):read("*all") end
+
+            -- STYLING
+            local styling = require("styling")
+            markdownFiles[index].content = styling.transform(markdownFiles[index].content)
+
+            -- start_idx, end_idx = c
+            -- {{pageContent}} shortcode
+            content = content:gsub("{{pageContent}}", markdownFiles[index].content)
+            -- {{pageTitle}} shortcode
+            content = content:gsub("{{pageTitle}}", markdownFiles[index].options["title"])
+
+            local start_idx, end_idx
+            -- list shortcodes
+            while content:find("{{list:}}", 1, true) do
+                start_idx, end_idx = content:find("{{list:}}")
+                if start_idx and end_idx then
+                    local first = content:sub(1, start_idx - 1)
+                    local second = content:sub(end_idx + 1)
+                    if second:find("{{:list}}", 1, true) then
+                        start_idx, end_idx = second:find("{{:list}}")
+                        if start_idx and end_idx then
+                            local shortcode = second:sub(1, start_idx - 1)
+                            local third = second:sub(end_idx + 1)
+                            shortcode = styling.formatShortcode(shortcode, markdownFiles, index)
+                            content = first .. shortcode .. third
+                        end
+                    end
+                end
+            end
+
+            htmlFile:write(content)
+            htmlFile:close()
+        else
+            print("Error: Cannot create html file for " .. markdownFiles[index].filePath)
+        end
+    end
+end

styling.lua

@@ -0,0 +1,170 @@
+local lfs = require("lfs")
+local module = {}
+local function styleLists(s)
+    local lines = {}
+    for line in (s .. "\n"):gmatch("([^\n]*)\n") do
+        table.insert(lines, line)
+    end
+
+    local result = {}
+    local inUl = false
+    local inOl = false
+
+    for _, line in ipairs(lines) do
+        local ulItem = line:match("^[%-%*%+]%s+(.*)")
+        local olItem = line:match("^%d+%.%s+(.*)")
+
+        if ulItem then
+            if inOl then
+                table.insert(result, "</ol>")
+                inOl = false
+            end
+            if not inUl then
+                table.insert(result, "<ul>")
+                inUl = true
+            end
+            table.insert(result, "<li>" .. ulItem .. "</li>") -- ulItem!
+        elseif olItem then
+            if inUl then
+                table.insert(result, "</ul>")
+                inUl = false
+            end
+            if not inOl then
+                table.insert(result, "<ol>")
+                inOl = true
+            end
+            table.insert(result, "<li>" .. olItem .. "</li>")
+        else
+            if inUl then
+                table.insert(result, "</ul>")
+                inUl = false
+            end
+            if inOl then
+                table.insert(result, "</ol>")
+                inOl = false
+            end
+            table.insert(result, line)
+        end
+    end
+
+    if inUl then
+        table.insert(result, "</ul>")
+    end
+    if inOl then
+        table.insert(result, "</ol>")
+    end
+
+    return table.concat(result, "\n")
+end
+local function styleParagraph(s)
+    local lines = {}
+    for line in (s .. "\n"):gmatch("([^\n]*)\n") do
+        table.insert(lines, line)
+    end
+
+    local result = {}
+    local pLines = {}
+
+    local function flushP()
+        if #pLines > 0 then
+            table.insert(result, "<p>" .. table.concat(pLines, "\n") .. "</p>")
+            pLines = {}
+        end
+    end
+
+    for _, line in ipairs(lines) do
+        local isBlock = line:match("^<") or line:match("^#")
+        local isEmpty = line:match("^%s*$")
+
+        if isBlock or isEmpty then
+            flushP()
+            table.insert(result, line)
+        else
+            table.insert(pLines, line)
+        end
+    end
+    flushP()
+
+    return table.concat(result, "\n")
+end
+function module.transform(s)
+    -- blockquote
+    local lines = {}
+    for line in (s .. "\n"):gmatch("([^\n]*)\n?") do
+        local nline = line:gsub("^>%s*(.*)", "<blockquote>%1</blockquote>")
+        table.insert(lines, nline)
+    end
+    s = table.concat(lines, "\n")
+    -- lists
+    s = styleLists(s)
+    -- paragraph
+    s = styleParagraph(s)
+    s = s:gsub("<p></p>", "")
+    -- line breaks
+    s = s:gsub("\r?\n", "<br>")
+    -- remove <br> tags around block elements
+    local blockTags = { "ul", "ol", "li", "blockquote", "p", "h1", "h2", "h3", "h4", "h5", "h6", "hr" }
+    for _, tag in ipairs(blockTags) do
+        s = s:gsub("(</" .. tag .. ">)<br>", "%1")
+        s = s:gsub("<br>(</" .. tag .. ">)", "%1")
+        s = s:gsub("(<" .. tag .. ">)<br>", "%1")
+        s = s:gsub("<br>(<" .. tag .. ">)", "%1")
+    end
+    -- self-closing hr
+    s = s:gsub("(<hr>)<br>", "%1")
+    s = s:gsub("<br>(<hr>)", "%1")
+    -- headers
+    s = s:gsub("######%s*(.-)%s*<br>", "<h6>%1</h6>")
+    s = s:gsub("#####%s*(.-)%s*<br>", "<h5>%1</h5>")
+    s = s:gsub("####%s*(.-)%s*<br>", "<h4>%1</h4>")
+    s = s:gsub("###%s*(.-)%s*<br>", "<h3>%1</h3>")
+    s = s:gsub("##%s*(.-)%s*<br>", "<h2>%1</h2>")
+    s = s:gsub("#%s*(.-)%s*<br>", "<h1>%1</h1>")
+    -- TODO: h1 and h2 using == and --
+    -- bold and italic text
+    s = s:gsub("%*%*(.-)%*%*", "<b>%1</b>")
+    s = s:gsub("%*(.-)%*", "<i>%1</i>")
+    s = s:gsub("%_%_(.-)%_%_", "<b>%1</b>")
+    s = s:gsub("%_(.-)%_", "<i>%1</i>")
+    -- images
+    s = s:gsub("!%[(.-)%]%((.-)%)", '<img src="%2" alt="%1"></img>')
+    -- links
+    s = s:gsub("%[(.-)%]%((.-)%)", '<a href="%2">%1</a>')
+    -- code
+    s = s:gsub("`(.-)`", "<code>%1</code>")
+    -- horizontal rule
+    s = s:gsub("%-%-%-", "<hr>")
+
+    return s
+end
+
+function module.formatShortcode(element, markdownFiles, index)
+    local dir = markdownFiles[index].filePath:match("(.*)/[^/]+%.md$")
+    local results = {}
+
+    for mdfile in lfs.dir(dir) do
+        if mdfile:match("%.md$") and mdfile ~= markdownFiles[index].fileName .. ".md" then
+            local fileName = mdfile:match("(.-)%.md$")
+
+            for i, _ in ipairs(markdownFiles) do
+                if markdownFiles[i].fileName == fileName then
+                    local copy = element
+
+                    -- replace items starting with list.item.
+                    for option in copy:gmatch("{{list%.item%.(.-)}}") do
+                        local value = markdownFiles[i].options[option]
+                        if value then
+                            copy = copy:gsub("{{list%.item%." .. option .. "}}", value)
+                        end
+                    end
+
+                    table.insert(results, copy)
+                end
+            end
+        end
+    end
+
+    return table.concat(results, "\n")
+end
+
+return module