doculet.net

What It Is

Doculet is a free, open-source tool for creating, sharing, and embedding code examples, positioned as an alternative to GitHub Gists. It is mainly aimed at technical blogs, Medium articles, and any website that supports iframes, with the goal of making code examples easier to present, copy, and explain. The project is currently marked as Beta, and its roadmap indicates that version 0.4.0 already covers the basic capabilities for editing, saving, publishing, and embedding.

Core Features and Ecosystem

Doculet’s core workflow uses GitHub login, imports GitHub Gists, lets users edit documents in an editor with preview, and then save, publish, share, or delete them. When saved, the document is written to GitHub as a new Gist in AsciiDoc format, while the original imported Gist remains unchanged. On the presentation side, it supports iframe embedding, and in Medium it can automatically expand into embedded content after you enter the URL. Readers can copy code with one click and switch between dark and light code themes.

Languages, Frameworks, and Document Format

The main text does not list which programming languages or syntax highlighting scopes are supported. It emphasizes AsciiDoc as the document markup language because AsciiDoc has built-in support for code callouts, making it easier to annotate and explain code with numbered markers. The author mentions that the project is related to VueJs, but that is part of the development background and does not mean the tool is only for Vue projects.

Pricing and Openness

Doculet is explicitly free to use, and its code is open source. The author explains that, to reduce the hosting cost of providing a free service, documents are actually stored using GitHub’s free Gist service. As a result, there is no additional fee, but users must have a GitHub account and grant Gist write permissions. The main text does not mention commercial plans, payment methods, SLAs, or enterprise support.

Pros and Cons

Its strengths are a clear positioning, lightweight design, free and open-source availability, and good alignment with the existing Gist workflow. AsciiDoc callouts are also more friendly for explaining code than ordinary comments. The limitations are also clear: it currently only works with GitHub and cannot be used without Gist storage; it is still in Beta, with bug fixes, more themes, search, and UX improvements still on the roadmap; and details about APIs, SDKs, self-hosting, and security have not been disclosed.

Who It’s For and Access from China

Doculet is suitable for developers writing technical articles, tutorials, and blogs, especially those already using GitHub Gist who want to embed better-looking code examples in Medium or their own websites. The main text does not describe access from China, and since the service depends on GitHub login and Gist, real-world availability may be affected by the network environment. It should therefore be treated as “unknown.” Alternatives include using GitHub Gists directly, or integrating a code highlighting component into your own blog.