Skip to main content

2 posts tagged with "Cire"

Cire Static Document Generator

View All Tags

Go Cire generate docs with ide features

· 11 min read
Yifan Song
Co-Founder Sparsee Tech(means hire my plz), ex-programming language enthusiast

Gocire is a static document generator that turns your source code into documents directly. It's highly inspired by Lean4 verso, Aya's literate programming mode and TypeScript's twoslash package. However compare to them, we turn the comment into document, and equip source code powerful IDE-like features, moreover, we support multiple programming languages, in fact, all languages supported by both Tree-Sitter and SCIP.

Gocire generate docs with ide features does work for multiple languages

· 2 min read
Yifan Song
Co-Founder Sparsee Tech(means hire my plz), ex-programming language enthusiast

Gocire supports multiple programming languages, yes.

Expand to view code
class GoCire {
    constructor(parameters) {
    }
}

In fact, we should be able to support all programming languages with support by Tree-Sitter with LSP or SCIP.

This is super helpful for programming languages with inference or gradual typing. For example, the monad language, Haskell, some people(me) really rely on editor's inlay hint or hover documentation to understand what's going on with types, and yes gocire supports Haskell with hls.

While for now, we cannot have multiple source code of multiple languages in one file, as we are using the source code itself as doc source, thus I have to demonstrate how it works on haskell in another file.