lun-4 / zig-docsearch

[WIP] search over zig stdlib doc comments (with rudimentary html gen)

zig-docsearch

NOTE: zig master now has in-progress docs! see ziglang/zig#21

search over zig stdlib doc comments (and generate a simple html file with what's possible)

WIP: using -fdump-analysis

using

zig build install --prefix ~/.local/

# build the state out of the std file in your zig installation
zig-docsearch ./state.bin build /path/to/zig/source/std/std.zig

# search through
zig-docsearch ./state.bin search 'mem'

# make a single html file
zig-docsearch ./state.bin htmlgen index.html

zig-docsearch's Issues

Syntax error when compiling with latest zig version

I'm new to Zig so I might be wrong, but I think this is due to newer versions changing the var in type declarations to anytype. Here's the error output:

diegovsky@ryzenarch ~/zig-docsearch (master)> zig build install --prefix ~/.local/
./src/state.zig:10:29: error: invalid token: 'var'
fn serializeStr(serializer: var, string: []const u8) !void {

Compile error on Linux x86 64 on master branch

./src/main.zig:52:29: error: container 'std.heap' has no member called 'direct_allocator'
    var allocator = std.heap.direct_allocator;

I'm using the latest zig compiler build, right from the master branch:

diegovsky@ryzenarch ~/zig-docsearch ((ce87ef9e…)) [1]> zig version
0.8.0-dev.1562+9f01598a4

port zig docgen's js-based search algorithm to zig-docsearch

use zig's -fdump-analysis instead of handrolled

experiment with html generation