Test Commit

.github/workflows/updatewiki.yml

@@ -0,0 +1,73 @@
+name: UpdateWiki
+on: [push, pull_request]
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        path: UpdateWiki
+
+    - uses: leafo/gh-actions-lua@v8.0.0
+      with:
+        luaVersion: "5.2"
+
+    - uses: leafo/gh-actions-luarocks@v4.0.0
+
+    - name: Pull gluacheck
+      uses: actions/checkout@v2
+      with:
+        repository: impulsh/gluacheck
+        path: luacheck
+
+    - name: Build gluacheck
+      working-directory: luacheck
+      run: luarocks make
+
+    - name: Lint
+      working-directory: helix
+      run: luacheck .
+
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          path: helix
+
+      - uses: leafo/gh-actions-lua@v8.0.0
+        with:
+          luaVersion: "5.2"
+
+      - uses: leafo/gh-actions-luarocks@v4.0.0
+
+      - name: Pull LDoc
+        uses: actions/checkout@v2
+        with:
+          repository: impulsh/LDoc
+          path: ldoc
+
+      - name: Build LDoc
+        working-directory: ldoc
+        run: luarocks make
+
+      - name: Build docs
+        working-directory: helix
+        run: ldoc . --fatalwarnings
+
+      - name: Copy assets
+        working-directory: helix
+        run: |
+          cp -v docs/css/* docs/html
+          cp -v docs/js/* docs/html
+
+      - name: Deploy
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository == 'NebulousCloud/helix' && success()
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: helix/docs/html
+          cname: docs.gethelix.co

config.ld

@@ -0,0 +1,77 @@
+
+file = {
+	"gamemode",
+	"plugins",
+	"docs/hooks",
+	exclude = {"gamemode/core/libs/thirdparty"}
+}
+
+module_file = {
+	Character = "gamemode/core/meta/sh_character.lua",
+	Entity = "gamemode/core/meta/sh_entity.lua",
+	Inventory = "gamemode/core/meta/sh_inventory.lua",
+	Item = "gamemode/core/meta/sh_item.lua",
+	Player = "gamemode/core/meta/sh_player.lua"
+}
+
+dir = "docs/html"
+project = "Helix"
+title = "Helix Documentation"
+
+no_space_before_args = true
+style = "docs/css"
+template = "docs/templates"
+format = "markdown"
+ignore = true
+topics = "docs/manual"
+use_markdown_titles = true
+kind_names = {module = "Libraries", topic = "Manual"}
+merge = true
+sort = true
+sort_modules = true
+
+simple_args_string = true -- we show optionals/defaults outside of the display name
+strip_metamethod_prefix = true -- remove the name of the table when displaying metamethod names
+no_viewed_topic_at_top = true -- don't put the currently viewed topic at the top
+use_new_templates = true -- new templating system
+pretty_urls = true -- avoid showing .html in urls
+pretty_topic_names = true -- strips extension from manual filenames, this does not check filename collisions
+
+custom_tags = {
+	{"realm", hidden = true},
+	{"internal", hidden = true}
+}
+
+custom_display_name_handler = function(item, default_handler)
+	if (item.type == "function" and item.module) then
+		if (item.module.type == "classmod" or item.module.type == "panel") then
+			return item.module.mod_name .. ":" .. default_handler(item)
+		elseif (item.module.type == "hooks") then
+			return item.module.mod_name:upper() .. ":" .. default_handler(item)
+		end
+	end
+
+	return default_handler(item)
+end
+
+new_type("hooks", "Hooks", true)
+new_type("panel", "Panels", true)
+
+-- helix types
+tparam_alias("char", "Character")
+tparam_alias("inventory", "Inventory")
+tparam_alias("item", "Item")
+tparam_alias("ixtype", "ix.type")
+tparam_alias("date", "date")
+
+-- standard types
+tparam_alias("string", "string")
+tparam_alias("bool", "boolean")
+tparam_alias("func", "function")
+tparam_alias("player", "Player")
+tparam_alias("entity", "Entity")
+tparam_alias("color", "color")
+tparam_alias("tab", "table")
+tparam_alias("material", "material")
+tparam_alias("vector", "vector")
+tparam_alias("angle", "angle")

docs/css/highlight.css

@@ -0,0 +1,96 @@
+/*
+
+github.com style (c) Vasily Polovnyov <vast@whiteants.net>
+
+*/
+
+.hljs {
+  display: block;
+  color: #333;
+}
+
+.hljs-comment,
+.hljs-quote {
+  color: #535346;
+  font-style: italic;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-subst {
+  color: #333;
+  font-weight: bold;
+}
+
+.hljs-number,
+.hljs-literal,
+.hljs-variable,
+.hljs-template-variable,
+.hljs-tag .hljs-attr {
+  color: #008080;
+}
+
+.hljs-string,
+.hljs-doctag {
+  color: #d14;
+}
+
+.hljs-title,
+.hljs-section,
+.hljs-selector-id {
+  color: #900;
+  font-weight: bold;
+}
+
+.hljs-subst {
+  font-weight: normal;
+}
+
+.hljs-type,
+.hljs-class .hljs-title {
+  color: #458;
+  font-weight: bold;
+}
+
+.hljs-tag,
+.hljs-name,
+.hljs-attribute {
+  color: #000080;
+  font-weight: normal;
+}
+
+.hljs-regexp,
+.hljs-link {
+  color: #009926;
+}
+
+.hljs-symbol,
+.hljs-bullet {
+  color: #990073;
+}
+
+.hljs-built_in,
+.hljs-builtin-name {
+  color: #0086b3;
+}
+
+.hljs-meta {
+  color: #999;
+  font-weight: bold;
+}
+
+.hljs-deletion {
+  background: #fdd;
+}
+
+.hljs-addition {
+  background: #dfd;
+}
+
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-strong {
+  font-weight: bold;
+}