https://github.com/lun-4/zig-docsearch

[WIP] search over zig stdlib doc comments (with rudimentary html gen)
https://github.com/lun-4/zig-docsearch

documentation-generator zig

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/lun-4/zig-docsearch
• Owner: lun-4
• License: mit
• Created: 2019-06-28T16:41:39.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-20T00:47:44.000Z (over 4 years ago)
• Last Synced: 2024-04-24T18:25:31.934Z (5 months ago)
• Topics: documentation-generator, zig
• Language: Zig
• Homepage:
• Size: 54.7 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zig-docsearch

**NOTE: zig master now has in-progress docs! see https://github.com/ziglang/zig/issues/21**

search over zig stdlib doc comments (and generate a simple html file with

what's possible)

WIP: using -fdump-analysis

## using

```bash

zig build install --prefix ~/.local/

```

```bash

# 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

```