About Doculet

Doculet is my side project and my goal to create an app to easily share and embed code examples on any website.

Why am I building this project?

When I was writing technical in articles in Medium, I couldn't find best tool to embed code examples. Medium's code block doesn't support syntax highlighting and Github gists was the only other option. Gists are ok, but we can't customize syntax highlight theme. Also, I wasn't happy with using standard code comments to explain the code.

I was looking for something better and I found that AsciiDoc supports annotating code with callouts. I abolutely loved it. In fact, I used a screen shot of AsciiDoc output in one of my article.

Meanwhile, I wanted to develop my front-end programming skills and I got excited about VueJs. Voila! The idea for Doculet project was born.

Github Integration

As most people currently use Gists to embed code, I am making it to work easily with Github. Gists can be imported and are automatically converted AsciiDoc format. When you save they are also saved as new gist in AsciiDoc format. The original imported Gist will be untouched.

FAQ

Is Doculet free to Use?

Yes. Doculet is free to use and also code is open sourced. Your contributions are welcome.

Why documents are saved as Gists?

Since It's free I want to reduce the hosting cost. So I am just using Github's free Gist support.

Why do I need to grant write access to Gist?

Because when you save, application has to write documents as Gists.

I don't have Github account. Can I still use Doculet?

No, currently Doculet works only with Github. So signup for free Github account to use Doculet. If you really need support for other cloud sources like Dropbox or Google drive, contact me by submiting issue in Github project. I can think about adding support if there is enough interest.

Why not use standard Markdown instead of AsciiDoc ?

AsciiDoc supports comment callouts and syntax is very similar to Markdown. So if you are already familar with Markdown, it's really easy to use AsciiDoc.

When will it be ready for use?

You can use it today in Medium articles. If you are able to use iframes, you can use it your website or blog. I will also make it easily work with other popular blogging platforms. Please subscribe to email list to stay tuned.

Also, the app is currently in beta, so if you find any bugs, please submit issue in Github.