@nobleai/rescript-documentation
v0.7.2
Published
NobleAI tool for generating rescript library documentation
Downloads
4
Readme
rescript-documentation
Script for producing markdown from @rescript/tools json output. Use this to generate documentation in github with their jekyl docs tooling, if you want.
Installation
yarn add -D @nobleai/rescript-documentation
Simple Use
yarn run rescript-doc <input-file>
Makefile
Here's an example of how you might use this in a Makefile:
RES_FILES = $(wildcard src/*.res) $(wildcard src/**/*.res)
MD_FILES := $(patsubst src/%,docs/generated/%,$(RES_FILES:.res=.md))
.PHONY: outdir all clean
outdir:
mkdir -p docs/generated
all: outdir $(MD_FILES) docs/index.md
docs/generated/%.md: src/%.res
yarn -s run rescript-tools doc $< > temp.json; yarn -s run rescript-doc temp.json > $@; rm temp.json
docs/index.md: outdir $(MD_FILES)
cat $(MD_FILES) > $@
clean:
rm -rf ./docs/generated