From 7ff0a0752a1092bd07042fb0357a5b571a386648 Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Mon, 13 Jul 2020 12:43:37 -0400 Subject: Include full path for cdnjs Include the full path for CDN delivery of highlight scritps to allow the user to browse the files from local without starting up a web server. --- README.md | 9 +++++---- share/index.etlua.lua | 5 +++-- share/page.etlua.lua | 5 +++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1bf94dc..12f40ad 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,16 @@ A documentation engine for Lua MDoc was built after frustrations with [LDoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html), -the usual and most popular documentation engine for lua. Like LDoc, MDoc users +the usual and most popular documentation engine for lua. Like LDoc, MDoc uses comments in the source code to generate html files for documentation. Unlike LDoc, it makes no attempts to be backwards compatible with LuaDoc. This results in a documentation engine that is free from constraints like "One class per -file" or "one module per file". MDoc is still in it's early stages, expect +file" or "one module per file", and allows for an architecture that is more +consistent and elegent overall. MDoc is still in it's early stages, expect frequent code churn in the near future. -MDoc is used to document my homebrew VR platform, [Brok\[en\]gine](https://cogarr.net/source/cgit.cgi/brokengine/), -and you can see an example of mdoc in action in the [Brok\[en\]gine reference](https://cogarr.net/brokengine/). +MDoc is used to document my homebrew game engine and VR platform, [Brok\[en\]gine](https://cogarr.net/source/cgit.cgi/brokengine/), +and you can see an example of mdoc in action at the [Brok\[en\]gine reference](https://cogarr.net/brokengine/). ## Installation diff --git a/share/index.etlua.lua b/share/index.etlua.lua index 9f07fff..4e8a7ca 100644 --- a/share/index.etlua.lua +++ b/share/index.etlua.lua @@ -6,8 +6,9 @@ return [[ <%- options.title %> - - + + + <%- navbar %> diff --git a/share/page.etlua.lua b/share/page.etlua.lua index 6e359e6..c66f865 100644 --- a/share/page.etlua.lua +++ b/share/page.etlua.lua @@ -5,8 +5,9 @@ return [[ <%- options.title %> - - + + + <%- navbar %> -- cgit v1.2.3-70-g09d2