Skip to content

Commit b51843d

Browse files
committed
initial work for adding docs
1 parent 12c8642 commit b51843d

File tree

6 files changed

+1819
-0
lines changed

6 files changed

+1819
-0
lines changed

docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Luvi documentation
2+
3+
Modules:
4+
5+
- [lminiz](./output/markdown/miniz.md)

docs/gen.lua

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
local fs = require 'fs'
2+
local join = require 'pathjoin'.pathJoin
3+
local generators = require './generators'
4+
5+
local function dir(path)
6+
if not fs.existsSync(path) then
7+
assert(fs.mkdirpSync(path))
8+
end
9+
return path
10+
end
11+
12+
-- TODO: a full CLI tool?
13+
14+
local output_dir = dir('./output')
15+
local input_dir = dir('./modules')
16+
17+
local modules_docs = {}
18+
for entry, entry_type in fs.scandirSync(input_dir) do
19+
if entry_type == 'file' then
20+
table.insert(modules_docs, dofile(join(input_dir, entry)))
21+
end
22+
end
23+
24+
for _, docs in ipairs(modules_docs) do
25+
for gen_name, generator in pairs(generators) do
26+
local content = generator.generate(docs)
27+
local dir_path = dir(join(output_dir, gen_name))
28+
local file_name = docs.name .. generator.extension
29+
assert(fs.writeFileSync(join(dir_path, file_name), content))
30+
end
31+
end

docs/generators/init.lua

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
return {
2+
markdown = require './markdown',
3+
}

0 commit comments

Comments
 (0)